Testing is accomplished via pytest. For more detailed information refer to the pytest documentation.
To get started first install the latest version of pytest as per their instructions:
pip install -U pytest
Currently all tests are located in src/tests
.
To start a complete testing run, simply run pytest
in the project directory:
pytest
If you only want to run all tests for a file that's:
pytest path/to/test_file.py
If you want to run a certain test for a file that's:
pytest path/to/test_file.py::test_function_name
Pytest will look for files that match *_test.py
or test_*.py
when searching for tests.
More detailed information about invoking pytest in the pytest docs: "How to invoke pytest"
When adding to this project you will want to ensure proper functionality by writing your own tests.