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.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ecc15c5cf5548c2d30ca08440c7cdfe1bc3b7ab513d48237896c0b368cb1e5c0 |
|
MD5 | 929965d29f2a36fbf0c43238c4826160 |
|
BLAKE2b-256 | 30bf4e6f9d640267a10c296d1e13bef9c28be1ecc27eda15e424c769b9930555 |
Hashes for hatch_jupyter_builder-0.8.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5963e4756a711f3642dfde1cf384b410af5d8b94910737b653a8125f5f683a7b |
|
MD5 | c0ebb7aeb12c9d8eda98b8c3b977d3ff |
|
BLAKE2b-256 | 4b316385db327766b865d998e33140cd792ecec588cbac31cfd5752c49ebe440 |