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.8.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0dbd14a8aef6636764f88a8fd1fcc9a91921e5c50356e6aab251782f264ae960 |
|
MD5 | 4d1e53ae27678888aa5e6c7485a33ac4 |
|
BLAKE2b-256 | b1b23c304707d4d3c30b2c87f1b8f8b2eb4a682662fea13bd5ab8f16c4c0eb0b |
Hashes for hatch_jupyter_builder-0.8.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d9e5666ee61877f31d49a2e0faafb034816c9813de65997baa691bd734092e54 |
|
MD5 | 68eeccb8ec9f42aca993f2d153ce1907 |
|
BLAKE2b-256 | 113fbe50e0763e2dc2b354d807caf4fec9b6f6b30f70926b2568e820c050ef82 |