Developer guide

Full setup

The following commands give you a complete development setup for aiida-testing. Make sure to run this in the appropriate virtual environment:

git clone https://github.com/aiidateam/aiida-testing.git
cd aiida-testing
pip install -e .[dev]
pre-commit install

Commands to install only parts of the development setup are included below.

Running the tests

The following will discover and run all unit tests:

pip install -e .[testing]
pytest

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, the prospector code analyzer, and the mypy static type checker will run at every commit.

If you ever need to skip these pre-commit hooks, just use:

git commit -n

Continuous integration

aiida-testing comes with a ci.yml file for continuous integration tests on every commit using GitHub Actions. It will:

  1. run all tests

  2. build the documentation

  3. check coding style and version number

Online documentation

The documentation of aiida-testing is continuously being built on ReadTheDocs, and the result is shown on https://aiida-testing.readthedocs.org/.

If you have a ReadTheDocs account, you can also enable it on your own fork for testing, but you will have to use a different name.

Local documentation

Of course, you can also build the documentation locally:

pip install -e .[docs]
cd docs
make

PyPI release

The process for creating a distribution and uploading it to PyPI is:

pip install twine
python setup.py sdist
twine upload dist/*

This can only be done by people who are registered as aiida-testing maintainers on PyPI. After this, you (and everyone else) should be able to:

pip install aiida-testing