Jupyter Packaging
Tools to help build and install Jupyter Python packages that require a pre-build step that may include JavaScript build steps.
Install
pip install jupyter-packaging
Usage
There are three ways to use jupyter-packaging in another package.
In general, you should not depend on jupyter_packaging as a runtime dependency, only as a build dependency.
As a Build Requirement
Use a pyproject.toml file as outlined in pep-518.
An example:
[build-system]
requires = ["jupyter_packaging>=0.10,<2"]
build-backend = "setuptools.build_meta"
Below is an example setup.py using the above config.
It assumes the rest of your metadata is in setup.cfg.
We wrap the import in a try/catch to allow the file to be run without jupyter_packaging
so that python setup.py can be run directly when not building.
from setuptools import setup
try:
from jupyter_packaging import wrap_installers, npm_builder
builder = npm_builder()
cmdclass = wrap_installers(pre_develop=builder, pre_dist=builder)
|