Skip to content

agoose77/hatch_jupyter_builder

This branch is 1 commit ahead of, 7 commits behind jupyterlab/hatch-jupyter-builder:main.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6b8ef06 · Jan 19, 2024
Jan 2, 2024
Jan 19, 2024
Jan 2, 2024
Jan 2, 2024
Oct 18, 2022
Jan 2, 2024
Sep 9, 2023
Apr 14, 2023
May 21, 2022
Jan 2, 2024
Dec 9, 2022
Nov 20, 2023

Repository files navigation

hatch-jupyter-builder

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

Documentation

The full documentation 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

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.

About

A hatch plugin to help build Jupyter packages

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 100.0%