diff --git a/README.md b/README.md index 4c1d33d..19c654e 100644 --- a/README.md +++ b/README.md @@ -49,3 +49,35 @@ Download the latest release in .tar.gz or .whl format and simply use pip install ```sh pip install PyCTBN-2.2.tar.gz ``` + +## Testing & Linting + +Install these dependencies for **tesing**: + +```sh +pip3 install -r test-requirements.txt +``` + +Install these dependencies for **linting**: + +```sh +pip3 install -r lint-requirements.txt +``` + +To launch **pytest**: + +```sh +pytest +``` + +To launch **flake8**: + +```sh +flake8 +``` + +To launch **pylint**: + +```sh +pylint --output-format=text --rcfile=setup.cfg src/ test/ *.py +``` diff --git a/test-requirements.txt b/test-requirements.txt index fcb0be0..40aa95d 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,3 +2,4 @@ pytest-xdist==2.2.1 setuptools==54.1.2 pytest==6.2.2 pytest-cov==2.11.1 +psutil==5.9.0