Development#
Using Poetry#
The Multiparser repository makes use of the Poetry which is a pip-installable dependency management and virtual environment tool for assisting development, and recommended when contributing to the project. The included poetry.lock file provides a shareable virtual environment definition. Poetry is able to resolve dependency versions to ensure cross-compatibility.
Pre-commit#
The repository includes a pre-commit configuration file which can be used to setup git hooks executed during committing. To install the hooks firstly ensure pre-commit is installed then run:
within the repository. You can manually run all hooks by executing:
Documentation#
Multiparser follows the Numpy docstring convention for outlining function and class parameters and return types.
Included within the git hooks is the docstring coverage check tool interrogate which checks whether all functions within the multiparser module have been documented. The tool can be run in isolation using Poetry: