Contributing¶
Prerequisites¶
Development¶
Install package:
pip install -e .[development]
Note
Use the -e, --editable flag to install the package in development mode.
Note
Set up a virtual environment for development.
Format source code:
autopep8 --recursive --in-place setup.py metastore/ tests/
Lint source code:
pylint setup.py metastore/ tests/
Test package:
pytest
Report test coverage:
pytest --cov --cov-fail-under 80
Note
Set the --cov-fail-under flag to 80% to validate the code coverage metric.
Build documentation:
cd docs/
sphinx-build -b html metastore/ build/
Note
This step will generate the API reference before building.