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>"]
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.6.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2d43217ed571a5bef19280dd64c325ed3748fa0a26a1057111db5fa02e779d0c |
|
MD5 | 1a841f0ef46e016f4d4bac4d051da090 |
|
BLAKE2b-256 | ad6a644d6903fb74023dd234145d20b416d7de92d236dead074af1bc725420b1 |
Hashes for hatch_jupyter_builder-0.6.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e6ef26873e182b68098a8f309bc27df3f654f5a06e80652d3d195393f65eb11 |
|
MD5 | b5ea6450b498601b07ea3f37b769435a |
|
BLAKE2b-256 | eb7187fcc561e746db44dfb13a7dedc9775a83ae6e011b5c1d13cb1ac61f2bc9 |