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 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.
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.9.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f31875c8236c84d29b629efa0f03a9483165d2c6e9b5253d1437c90ae31c3084 |
|
MD5 | 8f467a4d4f96344420b0f4f7392bbee4 |
|
BLAKE2b-256 | 1984e2a7e2d352d3dfc264c0e2653af12aaee56383428439eeeffeb3fad75152 |
Hashes for hatch_jupyter_builder-0.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b878144b158f6d93b8502ada4cf49b286d7790df1ff2c2e21823db42e328d6d6 |
|
MD5 | 532d6685378f4ffcc1610e54bd6670fa |
|
BLAKE2b-256 | 11a17fb7c1634cef55346de2a7b61e3eed1df9fe5546acb2e2741afa2aed31da |