A hatch plugin to help build Jupyter packages
Project description
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
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hatch_jupyter_builder-0.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fd118fb99ba6836d2b1484324164d2c15d59794699e02ee1b39d9a42b68ef939 |
|
MD5 | 6a53d72cf19ede7963789bd9c3e40cb0 |
|
BLAKE2b-256 | 14bbed885c7d7511029ad24242154e6aa10d0d12ce9202954739621605db2cee |
Hashes for hatch_jupyter_builder-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9c397d8b3511aa3b23c15dea55bd6a89c0165fad1c70664a2790dcb5a9c3980e |
|
MD5 | c7b345df584f43ec49ca671c858892ea |
|
BLAKE2b-256 | 0f447897eb1b6ad655128befa9af0d2058085595aaad05e5c0f467579aa00163 |