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>"]
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.6.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7d3c96a666d254237b88d780f15cb130e07e9dc8215306ffd4c3d0a3050a7748 |
|
MD5 | 91456e626daeaa4c2f56ad0f65f388c4 |
|
BLAKE2b-256 | 42ae536dd2922da4ac2bd61cc236f3c2f02cc204451bee0c968ee7fe7f8dad58 |
Hashes for hatch_jupyter_builder-0.6.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | baf3384420f7e869a0af4c27b5aa4627f508f3357d31dcc889dd6a38fd7e4fbc |
|
MD5 | 87f9385730ee48f568ae3bf9a7d94ace |
|
BLAKE2b-256 | 2a56fbdc07f2bdc6c46f7045864f99bcb32610e85e012136e5392c1a2e4dd821 |