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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | bae5eda6bacb700fd5120e95a5702f32615a7ce06ed8893b8700568d48baf46f |
|
MD5 | 404390cb1857ec8822e7e1781a4983fd |
|
BLAKE2b-256 | 94bff175815664a450334875d75dbf698e5e0025a7cc2c12f3bff3f2861d8791 |
Hashes for hatch_jupyter_builder-0.8.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 25018e8102184ee47c99fe7077db57278dfe8f389fe7f30e1ab32128a233403a |
|
MD5 | 5c33c47c34b1f9977956254aff8108eb |
|
BLAKE2b-256 | cf8c53d4a3036952a54a72f6383bfc991c4678bbc0d13c0f9876c537a28cb1f1 |