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.
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.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 46967b908065bd2f00dd9ad64c64e11637755083f0c513de2314b44320f4ba08 |
|
| MD5 | e918de90d14b35c9c52a74812bf9c493 |
|
| BLAKE2b-256 | dce51a5e859b0d0da469c96787112c451a854223a6d51754da7ce41f0a36ac0e |
Hashes for hatch_jupyter_builder-0.7.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 46714c4aed328723e0d0926c74fb589bd7bb17fbf2fd47dd1916e754d326d053 |
|
| MD5 | a62f0dc80ba2f514d0ecc9bab3e0fec7 |
|
| BLAKE2b-256 | 298df426e6027b282dcf167e6d6cfc8b770a8b68822fce18f16f65fac0c92a57 |
