Skip to main content

A hatch plugin to help build Jupyter packages

Project description


PyPI - Version Hatch project

This provides a build hook plugin for Hatch that adds a build step for use with Jupyter packages.

Table of Contents


The full documentation is available on Read The Docs.


pip install hatch-jupyter-builder

Local Development

To test this package locally with another package, use the following:

dependencies = ["hatch-jupyter-builder@file://<path_to_this_repo>"]

Skipping the Build

You can skip the build by setting the SKIP_JUPYTER_BUILDER environment variable.


This library can be used to migrate from a setuptools based package to use hatch_jupyter_builder. It will attempt to migrate jupyter-packaging config as well, if present.

To migrate, run the following:

python -m hatch_jupyter_builder.migrate .

The migration script will do most of the migration automatically, but will prompt you for anything it cannot do itself.

To compare dist files with a reference checkout, run the following:

python -m hatch_jupyter_builder.compare_migration <source_dir> <target_dir> sdist

Use wheel to compare wheel file contents.

See the documentation for more information on migration for more details.


hatch-jupyter-builder is distributed under the terms of the MIT license.

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

hatch_jupyter_builder-0.9.1.tar.gz (56.0 kB view hashes)

Uploaded Source

Built Distribution

hatch_jupyter_builder-0.9.1-py3-none-any.whl (18.6 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