Development

Requirements

python3 -m pip install pytest coverage pylint sphinx sphinx-autodoc-typehints furo

Install latest development version

1. Clone the GitHub repository:

   git clone git@github.com:snkas/discrevpy.git
   

2. Install locally using pip:

   cd discrevpy
   python3 -m pip install .
   

Run tests

All tests:

python3 -m pytest

Specific test showing stdout:

python3 -m pytest -s -k test_name

Calculate coverage

Outputs: .coverage, coverage.xml and htmlcov/

python3 -m coverage run --branch --omit="tests/*" -m pytest
python3 -m coverage xml
python3 -m coverage html

Pylint check

python3 -m pylint discrevpy/*.py

Generate documentation

Outputs HTML at docs/

cd docsrc
make html