1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
|
# hatch-jupyter-builder
[](https://pypi.org/project/hatch-jupyter-builder)
[](https://github.com/pypa/hatch)
______________________________________________________________________
This provides a [build hook](https://hatch.pypa.io/latest/config/build/#build-hooks) plugin for [Hatch](https://github.com/pypa/hatch) that adds a build step for use with Jupyter packages.
**Table of Contents**
- [Documentation](#documentation)
- [Installation](#installation)
- [License](#license)
- [Usage and Configuration](#usage_and_configuration)
- [Local Development](#local_development)
## Documentation
The full documenation is available on [Read The Docs](https://hatch-jupyter-builder.readthedocs.io/en/latest/).
## Installation
```console
pip install hatch-jupyter-builder
```
## Local Development
To test this package locally with another package, use the following:
```toml
[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:
```bash
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:
```bash
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.:
```bash
pipx hatch_jupyter_builder migrate .
```
Use `wheel` to compare wheel file contents.
See the [documentation for more information on migration](https://hatch-jupyter-builder.readthedocs.io/en/latest/source/how_to_guides/index.html) for more details.
## License
`hatch-jupyter-builder` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
|
