pkg_structure.rst

Package Structure

Reshapr/
├── docs
│   ├── design_notes
│   ├── _static
│   ├── subcommands
│   └── _templates
├── envs
├── .github
│   └── workflows
├── reshapr
│   ├── api
│   ├── cli
│   ├── core
│   └── utils
└── tests

Package Code Tree: :file:`reshapr/`

:file:`reshapr/api/`

Coming soon...

:file:`reshapr/cli/`

:file:`reshapr/cli/commands.py` contains the Click commands group into which sub-commands must be registered, and the :py:func:`reshapr.add_command` calls to register the sub-commands.

It is also where configuration of the structlog logging framework happens. All console output from the sub-commands is done via that logging.

The other modules in :file:`reshapr/cli/` contain the Click command-line interface functions for each of the sub-commands; e.g. :py:func:`reshapr.cli.extract.extract`.

:file:`reshapr/core/`

The modules in :file:`reshapr/core/` contain the implementation of the sub-commands; e.g. :py:mod:`reshapr.core.extract`.

Note

The functions in the :file:`reshapr/core/` modules are not intended to be called directly. They are accessed either via their command-line interface in :ref:`ReshaprCLIDirectory`, or via their API interface in :ref:`ReshaprAPIDirectory`.

:file:`reshapr/utils/`

Coming soon...