Skip to content

A set of utility functions for working with GeoJSON annotations in Kaibu

License

Notifications You must be signed in to change notification settings

imjoy-team/kaibu-utils

Repository files navigation

kaibu-utils

A set of utility functions for working with Kaibu.

Create a new repository

  • Create a new repository and select imjoy-team/imjoy-python-template as template repository.
  • Clone your new repository.
  • Search and replace all occurrences of kaibu-utils. Replace kaibu-utils with the name of the new repository.
  • Add package requirements in install_requires in setup.py and in requirements.txt as needed.
  • Update this README.md with a description and instructions for your new repository.

Development

  • Install and set up development environment.

    pip install -r requirements_dev.txt

    This will install all requirements. It will also install this package in development mode, so that code changes are applied immediately without reinstall necessary.

  • Here's a list of development tools we use.

  • It's recommended to use the corresponding code formatter and linters also in your code editor to get instant feedback. A popular editor that can do this is vscode.

  • Run all tests, check formatting and linting.

    tox
  • Run a single tox environment.

    tox -e lint
  • Reinstall all tox environments.

    tox -r
  • Run pytest and all tests.

    pytest
  • Run pytest and calculate coverage for the package.

    pytest --cov-report term-missing --cov=kaibu-utils
  • Continuous integration is by default supported via GitHub actions. GitHub actions is free for public repositories and comes with 2000 free Ubuntu build minutes per month for private repositories.

About

A set of utility functions for working with GeoJSON annotations in Kaibu

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published