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
Installation
pip install hatch-jupyter-builder
License
hatch-jupyter-builder
is distributed under the terms of the MIT license.
Usage and Configuration
The build hook plugin name is jupyter-builder
.
-
pyproject.toml
[tool.hatch.build.hooks.jupyter-builder] dependencies = ["hatch-jupyter-builder"] build-function = "hatch_jupyter_builder.npm_builder" ensured-targets = ["foo/generated.txt"] install-pre-commit-hook = true [tool.hatch.build.hooks.jupyter-builder.build-kwargs] build_cmd = "build:src"
Options
The only required fields are dependencies
and build-function
.
The build function is defined as an importable string with a module and a function name, separated by a period. The function must accept a
target_name
(either "wheel" or "sdist"), and a version
(either "standard" or "editable") as its only positional arguments. E.g.
-
builder.py
def build_func(target_name, version): ...
Would be defined as build-function = "builder.build_func"
The optional ensured-targets
is a list of expected file paths after building a
"standard" version sdist or wheel.
The optional build-kwargs
is a set of keyword arguments to pass to the build
function.
You can also use editable-build-kwargs
if the parameters should differ
in editable mode. If only the build command is different, you can use
editable_build_cmd
in build-kwargs
instead.
The optional install-pre-commit-hook
boolean causes a pre-commit
hook to be installed during an editable install.
Npm Builder Function
This library provides a convenenice npm_builder
function which can be
used to build npm
assets as part of the build.
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>"]
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.3.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1e55b1edc0762e48984aa981096bea9baca1acb540612243a290de77f3cf03cd |
|
MD5 | 5709b54cb39246e4ce692c321db92065 |
|
BLAKE2b-256 | a3a3ce44934686f00aad8d7d8d1589efb6d9753e31cc384e4c439bcf176d072d |
Hashes for hatch_jupyter_builder-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31d8cef8e2a9321d198c0ea95ca2ba2f2ad98ef13daa5b8059e6ee65cfba8589 |
|
MD5 | b4075001356205725ac86a51bf439527 |
|
BLAKE2b-256 | 1d7398893236c8d43f139910f9f60035297fbc6fa682c0ca163603581b5b12a6 |