| 1 |
Metadata-Version: 2.1 |
| 2 |
Name: hatch-jupyter-builder |
| 3 |
Version: 0.8.3 |
| 4 |
Summary: A hatch plugin to help build Jupyter packages |
| 5 |
Project-URL: Documentation, https://github.com/jupyterlab/hatch-jupyter-builder#readme |
| 6 |
Project-URL: Issues, https://github.com/jupyterlab/hatch-jupyter-builder/issues |
| 7 |
Project-URL: Source, https://github.com/jupyterlab/hatch-jupyter-builder |
| 8 |
Author-email: Jupyter Development Team <[email protected]> |
| 9 |
License: Copyright (c) 2022 Project Jupyter Contributors |
| 10 |
All rights reserved. |
| 11 |
|
| 12 |
Redistribution and use in source and binary forms, with or without |
| 13 |
modification, are permitted provided that the following conditions are met: |
| 14 |
|
| 15 |
1. Redistributions of source code must retain the above copyright notice, this |
| 16 |
list of conditions and the following disclaimer. |
| 17 |
|
| 18 |
2. Redistributions in binary form must reproduce the above copyright notice, |
| 19 |
this list of conditions and the following disclaimer in the documentation |
| 20 |
and/or other materials provided with the distribution. |
| 21 |
|
| 22 |
3. Neither the name of the copyright holder nor the names of its |
| 23 |
contributors may be used to endorse or promote products derived from |
| 24 |
this software without specific prior written permission. |
| 25 |
|
| 26 |
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 27 |
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 28 |
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| 29 |
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE |
| 30 |
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
| 31 |
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
| 32 |
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
| 33 |
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| 34 |
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 35 |
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 36 |
License-File: LICENSE.txt |
| 37 |
Keywords: hatch,jupyter,jupyterlab |
| 38 |
Classifier: Development Status :: 4 - Beta |
| 39 |
Classifier: License :: OSI Approved :: BSD License |
| 40 |
Classifier: Programming Language :: Python |
| 41 |
Classifier: Programming Language :: Python :: 3.8 |
| 42 |
Classifier: Programming Language :: Python :: 3.9 |
| 43 |
Classifier: Programming Language :: Python :: 3.10 |
| 44 |
Classifier: Programming Language :: Python :: 3.11 |
| 45 |
Classifier: Programming Language :: Python :: Implementation :: CPython |
| 46 |
Classifier: Programming Language :: Python :: Implementation :: PyPy |
| 47 |
Requires-Python: >=3.8 |
| 48 |
Requires-Dist: hatchling>=1.5 |
| 49 |
Provides-Extra: docs |
| 50 |
Requires-Dist: hatch-jupyter-builder; extra == 'docs' |
| 51 |
Requires-Dist: myst-parser; extra == 'docs' |
| 52 |
Requires-Dist: pydata-sphinx-theme; extra == 'docs' |
| 53 |
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs' |
| 54 |
Requires-Dist: sphinxcontrib-spelling; extra == 'docs' |
| 55 |
Provides-Extra: test |
| 56 |
Requires-Dist: hatch; extra == 'test' |
| 57 |
Requires-Dist: pytest; extra == 'test' |
| 58 |
Requires-Dist: pytest-cov; extra == 'test' |
| 59 |
Requires-Dist: pytest-mock; extra == 'test' |
| 60 |
Requires-Dist: tomli; extra == 'test' |
| 61 |
Requires-Dist: twine; extra == 'test' |
| 62 |
Description-Content-Type: text/markdown |
| 63 |
|
| 64 |
# hatch-jupyter-builder |
| 65 |
|
| 66 |
[](https://pypi.org/project/hatch-jupyter-builder) |
| 67 |
[](https://github.com/pypa/hatch) |
| 68 |
|
| 69 |
______________________________________________________________________ |
| 70 |
|
| 71 |
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. |
| 72 |
|
| 73 |
**Table of Contents** |
| 74 |
|
| 75 |
- [Documentation](#documentation) |
| 76 |
- [Installation](#installation) |
| 77 |
- [License](#license) |
| 78 |
- [Usage and Configuration](#usage_and_configuration) |
| 79 |
- [Local Development](#local_development) |
| 80 |
|
| 81 |
## Documentation |
| 82 |
|
| 83 |
The full documenation is available on [Read The Docs](https://hatch-jupyter-builder.readthedocs.io/en/latest/). |
| 84 |
|
| 85 |
## Installation |
| 86 |
|
| 87 |
```console |
| 88 |
pip install hatch-jupyter-builder |
| 89 |
``` |
| 90 |
|
| 91 |
## Local Development |
| 92 |
|
| 93 |
To test this package locally with another package, use the following: |
| 94 |
|
| 95 |
```toml |
| 96 |
[tool.hatch.build.hooks.jupyter-builder] |
| 97 |
dependencies = ["hatch-jupyter-builder@file://<path_to_this_repo>"] |
| 98 |
``` |
| 99 |
|
| 100 |
## Skipping the Build |
| 101 |
|
| 102 |
You can skip the build by setting the `SKIP_JUPYTER_BUILDER` environment |
| 103 |
variable. |
| 104 |
|
| 105 |
## Migration |
| 106 |
|
| 107 |
This library can be used to migrate from a `setuptools` based package to |
| 108 |
use `hatch_jupyter_builder`. It will attempt to migrate `jupyter-packaging` |
| 109 |
config as well, if present. |
| 110 |
|
| 111 |
To migrate, run the following: |
| 112 |
|
| 113 |
```bash |
| 114 |
python -m hatch_jupyter_builder.migrate . |
| 115 |
``` |
| 116 |
|
| 117 |
The migration script will do most of the migration automatically, but |
| 118 |
will prompt you for anything it cannot do itself. |
| 119 |
|
| 120 |
To compare dist files with a reference checkout, run the following: |
| 121 |
|
| 122 |
```bash |
| 123 |
python -m hatch_jupyter_builder.compare_migration <source_dir> <target_dir> sdist |
| 124 |
``` |
| 125 |
|
| 126 |
The migration scripts can also be used without installation, using `pipx`, e.g.: |
| 127 |
|
| 128 |
```bash |
| 129 |
pipx hatch_jupyter_builder migrate . |
| 130 |
``` |
| 131 |
|
| 132 |
Use `wheel` to compare wheel file contents. |
| 133 |
|
| 134 |
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. |
| 135 |
|
| 136 |
## License |
| 137 |
|
| 138 |
`hatch-jupyter-builder` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license. |