Repository files navigation

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

Table of Contents

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

The full documentation is available onRead The Docs.

pip install hatch-jupyter-builder

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>"]

You can skip the build by setting theSKIP_JUPYTER_BUILDER environmentvariable.

This library can be used to migrate from asetuptools based package tousehatch_jupyter_builder. It will attempt to migratejupyter-packagingconfig 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, butwill 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

Usewheel to compare wheel file contents.

See thedocumentation for more information on migration for more details.

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