hatch-jupyter-builder

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

Table of Contents

• Documentation
• Installation
• License
• Usage and Configuration
• Local Development

Documentation

The full documenation is available on Read The Docs.

Installation

pip install hatch-jupyter-builder

Local Development

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

[tool.hatch.build.hooks.jupyter-builder]
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.

Migration

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

The migration scripts can also be used without installation, using pipx, e.g.:

pipx hatch_jupyter_builder migrate .

Use wheel to compare wheel file contents.

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

License

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