Development conventions

How to work with the existing cellfinder developers

Pull requests

In all cases, please submit code to the main repository via a pull request. Upon approval, please merge via "Squash and Merge" on GitHub to maintain a clean commit history.

Please submit pull requests as early as possible (you can still push to the branch once submitted) to allow discussion.

Formatting

cellfinder uses Black and Flake8 to ensure a consistent code style. Please run pre-commit install prior to working on the code to ensure that these tests are run on each commit.

To check your code before committing, please run:

black ./
flake8

Testing

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.

Some tests may take a long time (e.g. those requiring tensorflow if you don't have a GPU). These tests should be marked with @pytest.mark.slow, e.g.:

import pytest
@pytest.mark.slow
def test_something_slow():
slow_result = run_slow_processes()
assert slow_result == expected_slow_thing

During development, these "slow" tests can be skipped by running pytest -m "not slow".

Travis

All commits & pull requests will be build by GitHub actions. To ensure there are no issues, please check that it builds: pip install . and run all of the tests: pytest before committing changes.

Dependencies

The code in the cellfinder repository should be primarily the analysis of whole-brain microscopy images. Other changes should be added to the relevant repository:

File paths

All file paths should be defined in 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.

Versioning

Versioning is taken care of using bump2version. By using the 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:

  • Bump to new patch version (e.g. 1.0.0 to 1.0.1-rc0): bump2version patch

  • Bump to new minor version (e.g. 1.0.0 to 1.1.0-rc0): bump2version minor

  • Bump to new major version (e.g. 1.0.0 to 2.0.0-rc0): bump2version major

  • Bump to new release candidate version (e.g. 1.0.0-rc0 to 1.0.0-rc1): bump2version rc

  • To create a new release version (e.g. 1.0.0-rc0 to 1.0.0): bump2version release