cellfinder
uses Black, Flake8, isort and mypy to ensure a consistent code style. You may need to run pre-commit install
prior to working on the code to ensure that these tests are run on each commit if you haven't installed as [dev]
.cellfinder
uses pytest for testing. Please try to ensure that all functions are tested in tests/tests/test_unit
and all workflows/command-line tools are tested in tests/tests/test_integration
.@pytest.mark.slow
, e.g.:pytest -m "not slow"
.pip install .
and run all of the tests: pytest
before committing changes.cellfinder.tools.prep.Paths
. Any intermediate file paths, (i.e. those which are not of interest to the typical end user) should be prefixed with tmp__
. These should then be cleaned up as soon as possible after generation.bump2version
command, new versions are incremented, a git tag is made, and when pushed to the remote repository, that version will be deployed to PyPI. Usage is as follows:1.0.0
to 1.0.1-rc0
): bump2version patch
1.0.0
to 1.1.0-rc0
): bump2version minor
1.0.0
to 2.0.0-rc0
): bump2version major
1.0.0-rc0
to 1.0.0-rc1
): bump2version rc
1.0.0-rc0
to 1.0.0
): bump2version release