experimental/cuda-ubi9/: hatch-jupyter-builder-0.9.1 metadata and description

Simple index

A hatch plugin to help build Jupyter packages

author_email Jupyter Development Team <jupyter@googlegroups.com>
classifiers
  • Development Status :: 4 - Beta
  • License :: OSI Approved :: BSD License
  • Programming Language :: Python
  • Programming Language :: Python :: 3 :: Only
  • Programming Language :: Python :: Implementation :: CPython
  • Programming Language :: Python :: Implementation :: PyPy
description_content_type text/markdown
keywords hatch,jupyter,jupyterlab
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.
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
provides_extras test
requires_dist
  • hatchling>=1.17
  • myst-parser; extra == 'docs'
  • pydata-sphinx-theme; extra == 'docs'
  • sphinx-autodoc-typehints; extra == 'docs'
  • sphinxcontrib-spelling; extra == 'docs'
  • hatch; extra == 'test'
  • pytest; extra == 'test'
  • pytest-cov; extra == 'test'
  • pytest-mock; extra == 'test'
  • tomli; (python_version < '3.11') and extra == 'test'
  • twine; extra == 'test'
requires_python >=3.8
File Tox results History
hatch_jupyter_builder-0.9.1-py3-none-any.whl
Size
18 KB
Type
Python Wheel
Python
3

hatch-jupyter-builder

PyPI - Version Hatch project

This provides a build hook plugin for Hatch that adds a build step for use with Jupyter packages.

Table of Contents

Documentation

The full documentation 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

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.