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.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fb39c0add20341e02b14bc585e22c3218c9bd81f3235e9b3b5f5e07e34788f23 |
|
MD5 | 1a950ad9e6140b2ce47bfaf1e5b3f0a6 |
|
BLAKE2b-256 | 608078b141c3aebe1aac33758c19160df4d66f2e14f2522801fe0afb79bbb997 |
Hashes for hatch_jupyter_builder-0.6.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | fbcdec1a2b51e3c6e7f65e5c3deacfbbfa53c258d1bec32df23e94fee0ee21e3 |
|
MD5 | 627b74e017ab63dc131d2b20fd3fcef7 |
|
BLAKE2b-256 | 39e48436f7218955baafccd4b5b084cf3fed5cf2a881e7b7d0a11777417da89b |