Developer guide¶
Running the tests¶
The following will discover and run all unit test:
pip install -e .[testing]
pytest -v
Automatic coding style checks¶
Enable enable automatic checks of code sanity and coding style:
pip install -e .[pre-commit]
pre-commit install
After this, the yapf formatter, the pylint linter and the prospector code analyzer will run at every commit.
If you ever need to skip these pre-commit hooks, just use:
git commit -n
Continuous integration¶
aiida-ce comes with a .travis.yml file for continuous integration tests on every commit using Travis CI. It will:
- run all tests for the
djangoandsqlalchemyORM - build the documentation
- check coding style and version number (not required to pass by default)
Just enable Travis builds for the aiida-ce repository in your Travis account.
aiida-ce also includes an azure-pipelines.yml file for continuous integration tests using Azure Pipelines.
Online documentation¶
The documentation of aiida-ce
is ready for ReadTheDocs:
Simply add the aiida-ce repository on your RTD profile, preferably using aiida-ce as the project name - that’s it!
PyPI release¶
Your plugin is ready to be uploaded to the Python Package Index. Just register for an account and:
pip install twine
python setup.py sdist bdist_wheel
twine upload dist/*
After this, you (and everyone else) should be able to:
pip install aiida-ce