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.
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
File details
Details for the file hatch_jupyter_builder-0.8.2.tar.gz.
File metadata
- Download URL: hatch_jupyter_builder-0.8.2.tar.gz
- Upload date:
- Size: 53.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 6436daace48622cefc8585c5d2988a1046c074b65ab5715de04666535a5edff7 |
|
| MD5 | ad696696e21aef42d951b6bfafef1a48 |
|
| BLAKE2b-256 | cb4136439341fd58e37166241fc283d4cd1953e8c7cbf84d7050911b43532332 |
Provenance
File details
Details for the file hatch_jupyter_builder-0.8.2-py3-none-any.whl.
File metadata
- Download URL: hatch_jupyter_builder-0.8.2-py3-none-any.whl
- Upload date:
- Size: 17.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.10.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f1134b4d92f466d4ab6c66a7e2c3434110441541e6d5597cb5c431a6f67b7823 |
|
| MD5 | 63874c26367bf2de3bfda655a04e16ac |
|
| BLAKE2b-256 | 3eba00fb8d5a09b6bcde63906b6fcbcf0f670b7f8b58601165859b4bc2882159 |
