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.
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.1.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 79278198d124c646b799c5e8dca8504aed9dcaaa88d071a09eb0b5c2009a58ad |
|
| MD5 | 34453f370ea94957872c1313cf80f0ce |
|
| BLAKE2b-256 | 5bf68c8b353e7c6476ca28caea0408b0a3778d8849cda16f3e8e8f3145162dae |
Hashes for hatch_jupyter_builder-0.9.1-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d70294ba5028a880cecfc8f3609b12e1280a35201c551663b1a2501532b513f5 |
|
| MD5 | d22dc218c662fbbeb612a950b0657a38 |
|
| BLAKE2b-256 | 9fcebe681f7af8141eabe61df05c7990db3bafe0ea9e2d7cec9329fad75a00e4 |
