| Name | hatch-jupyter-builder JSON |
| Version |
0.9.0
JSON |
| download |
| home_page | |
| Summary | A hatch plugin to help build Jupyter packages |
| upload_time | 2024-03-12 12:22:28 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Copyright (c) 2022 Project Jupyter Contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
hatch
jupyter
jupyterlab
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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 documentation 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
```
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.
Raw data
{
"_id": null,
"home_page": "",
"name": "hatch-jupyter-builder",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "hatch,jupyter,jupyterlab",
"author": "",
"author_email": "Jupyter Development Team <jupyter@googlegroups.com>",
"download_url": "https://files.pythonhosted.org/packages/19/84/e2a7e2d352d3dfc264c0e2653af12aaee56383428439eeeffeb3fad75152/hatch_jupyter_builder-0.9.0.tar.gz",
"platform": null,
"description": "# hatch-jupyter-builder\n\n[](https://pypi.org/project/hatch-jupyter-builder)\n[](https://github.com/pypa/hatch)\n\n______________________________________________________________________\n\nThis 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.\n\n**Table of Contents**\n\n- [Documentation](#documentation)\n- [Installation](#installation)\n- [License](#license)\n- [Usage and Configuration](#usage_and_configuration)\n- [Local Development](#local_development)\n\n## Documentation\n\nThe full documentation is available on [Read The Docs](https://hatch-jupyter-builder.readthedocs.io/en/latest/).\n\n## Installation\n\n```console\npip install hatch-jupyter-builder\n```\n\n## Local Development\n\nTo test this package locally with another package, use the following:\n\n```toml\n[tool.hatch.build.hooks.jupyter-builder]\ndependencies = [\"hatch-jupyter-builder@file://<path_to_this_repo>\"]\n```\n\n## Skipping the Build\n\nYou can skip the build by setting the `SKIP_JUPYTER_BUILDER` environment\nvariable.\n\n## Migration\n\nThis library can be used to migrate from a `setuptools` based package to\nuse `hatch_jupyter_builder`. It will attempt to migrate `jupyter-packaging`\nconfig as well, if present.\n\nTo migrate, run the following:\n\n```bash\npython -m hatch_jupyter_builder.migrate .\n```\n\nThe migration script will do most of the migration automatically, but\nwill prompt you for anything it cannot do itself.\n\nTo compare dist files with a reference checkout, run the following:\n\n```bash\npython -m hatch_jupyter_builder.compare_migration <source_dir> <target_dir> sdist\n```\n\nUse `wheel` to compare wheel file contents.\n\nSee the [documentation for more information on migration](https://hatch-jupyter-builder.readthedocs.io/en/latest/source/how_to_guides/index.html) for more details.\n\n## License\n\n`hatch-jupyter-builder` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2022 Project Jupyter Contributors All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "A hatch plugin to help build Jupyter packages",
"version": "0.9.0",
"project_urls": {
"Documentation": "https://github.com/jupyterlab/hatch-jupyter-builder#readme",
"Issues": "https://github.com/jupyterlab/hatch-jupyter-builder/issues",
"Source": "https://github.com/jupyterlab/hatch-jupyter-builder"
},
"split_keywords": [
"hatch",
"jupyter",
"jupyterlab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "11a17fb7c1634cef55346de2a7b61e3eed1df9fe5546acb2e2741afa2aed31da",
"md5": "532d6685378f4ffcc1610e54bd6670fa",
"sha256": "b878144b158f6d93b8502ada4cf49b286d7790df1ff2c2e21823db42e328d6d6"
},
"downloads": -1,
"filename": "hatch_jupyter_builder-0.9.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "532d6685378f4ffcc1610e54bd6670fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 18470,
"upload_time": "2024-03-12T12:22:26",
"upload_time_iso_8601": "2024-03-12T12:22:26.022657Z",
"url": "https://files.pythonhosted.org/packages/11/a1/7fb7c1634cef55346de2a7b61e3eed1df9fe5546acb2e2741afa2aed31da/hatch_jupyter_builder-0.9.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1984e2a7e2d352d3dfc264c0e2653af12aaee56383428439eeeffeb3fad75152",
"md5": "8f467a4d4f96344420b0f4f7392bbee4",
"sha256": "f31875c8236c84d29b629efa0f03a9483165d2c6e9b5253d1437c90ae31c3084"
},
"downloads": -1,
"filename": "hatch_jupyter_builder-0.9.0.tar.gz",
"has_sig": false,
"md5_digest": "8f467a4d4f96344420b0f4f7392bbee4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 55764,
"upload_time": "2024-03-12T12:22:28",
"upload_time_iso_8601": "2024-03-12T12:22:28.454480Z",
"url": "https://files.pythonhosted.org/packages/19/84/e2a7e2d352d3dfc264c0e2653af12aaee56383428439eeeffeb3fad75152/hatch_jupyter_builder-0.9.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-12 12:22:28",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jupyterlab",
"github_project": "hatch-jupyter-builder#readme",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "hatch-jupyter-builder"
}
