Skip to main content

A set of utility functions for working with Kaibu(

Project description


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 and in requirements.txt as needed.
  • Update this with a description and instructions for your new repository.


  • 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.

  • Run a single tox environment.

    tox -e lint
  • Reinstall all tox environments.

    tox -r
  • Run pytest and all tests.

  • 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.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kaibu-utils-0.1.14.tar.gz (7.8 kB view hashes)

Uploaded Source

Built Distribution

kaibu_utils-0.1.14-py3-none-any.whl (7.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page