Contribute

To contribute to the development of this package, check out its Github repository and push commits there.

How do we handle pip requirements?

We mostly follow this workflow:

1. Add packages to requirements.in. Only pin versions that need to be pinned to make the code runnable.

2. Run the pip-compile command shown at the top of the requirements.txt to freeze requirements.

3. Commit requirements.in and requirements.txt in a PR. Once merged to main, Cloudbuild will build the image with the new dependencies.

Tests

You can run tests by executing pytest. Prior make sure that you installed the testing extras via pip install -e '.[dev,dask,gcp,torch,zarr]'.

Build the documentation locally

To build the documentation locally, make sure you install dev requirements by running pip install -r requirements.dev.in. Running sphinx-build ./docs ./docs/build from the root directory will generate the documentation.

Python Code Style Guide

We use PEP8 with some modifications. We use pre-commit to automatically check most of these points. Visit their website to find out how to setup pre-commit for this repository and check your contributions before opening a PR. You can run pre-commit run --all-files. See the file .pre-commit-config.yaml in the root directory of the repo for more details.