Development

If you are developing or want to contribute to Solosis, please read this page.

You can clone the repo to your preferred development location

git clone git@github.com:haniffalab/solosis.git
cd solosis

Create and activate the virtual environment

python -m venv .venv
source .venv/bin/activate

Install dev dependencies and install pre-commit hooks

python -m pip install -r envs/dev/requirements.txt
pre-commit install

For Github Actions to pass, will need to ensure black formatting and isort are implemented. You can manually check black formatting and isort

black path/to/file.py

isort path/to/file.py

Python testing

Testing of python scripts uses `pytest`_.

Set the PYTHONPATH environment variable to the bin directory where the scripts are stored, and then run the following command:

python -m pytest -q tests/test_cli.py