Python module structure

This page gives an overview of how GDPC is structured in terms of importable modules. You may find it useful when browsing the API reference or when contributing to GDPC.

GDPC has a flat module structure, but its modules roughly fit in one of three categories:

  1. Core interface.

    These modules are tightly connected, and form the core interface of GDPC. Most classes defined in these modules can also be imported directly from the root package gdpc.

  2. Additional tools.

    These modules contain additional utility functions/classes that work on top of the core interface. You could in principle re-implement anything from these modules yourself without losing any functionality.

  3. Internal utilities.

    These modules contain utilities that are mostly just for the internal workings of the library, but may still be useful. It’s recommended to use the higher-level tools from the previous two categories when possible.