---
id: hatch-jupyter-builder
version: "0.9.1"
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… (full text in the JSON record)
license_treatment: permissive
maintenance: dormant
---

# hatch-jupyter-builder — A hatch plugin to help build Jupyter packages

License: permissive · Maintenance: dormant · Downloads: 188.0K/mo

## What it is and what it does

hatch-jupyter-builder is a Hatch build hook that integrates custom build steps into the Jupyter package creation workflow. It acts as a bridge between Hatch's build system and Jupyter-specific compilation tasks—such as building frontend assets or running custom build scripts—that need to run before the final package is assembled. The plugin is designed for maintainers migrating from setuptools and jupyter-packaging to Hatch, and includes a migration utility to help convert existing configurations.

When configured in a project's pyproject.toml, the hook intercepts the build process and executes Jupyter-specific build steps automatically. It can be skipped via the SKIP_JUPYTER_BUILDER environment variable for development workflows. The package is maintained by the Jupyter project and supports Python 3.8 and later, including both CPython and PyPy implementations.

Use it for:

- Building JupyterLab extensions or plugins that require frontend asset compilation before packaging.
- Migrating an existing setuptools-based Jupyter package to Hatch with minimal configuration changes.
- Automating custom build steps (e.g., TypeScript compilation, webpack bundling) as part of the Hatch build pipeline.
- Comparing distribution artifacts when migrating from jupyter-packaging to verify build output consistency.
- Skipping build steps in development environments while keeping them active in CI/release builds.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

A Hatch build hook plugin that automates the build process for Jupyter packages, handling compilation and asset steps during package creation.

Yes, if you are building Jupyter packages with Hatch and need to automate custom build steps. The low install friction and permissive license make it straightforward to adopt. However, note the dormant maintenance status—no releases for 885 days—so verify compatibility with your current Hatch and Jupyter versions before relying on it for new projects. It is most suitable for teams already committed to Hatch or migrating from jupyter-packaging.

## Install

pip install hatch-jupyter-builder
uv add hatch-jupyter-builder
poetry add hatch-jupyter-builder

## Installing hatch-jupyter-builder

Before you install: Low friction installation with a single runtime dependency on hatchling. The project is dormant (last commit 2024-06-16, no release for 885 days), but remains available and functional for existing Jupyter packaging workflows.

License in practice: Distributed under a permissive BSD license, allowing commercial and private use with minimal restrictions—only requiring preservation of copyright and license text in redistributions.

Quickstart:

pip install hatch-jupyter-builder

# In pyproject.toml:
[tool.hatch.build.hooks.jupyter-builder]
dependencies = ["hatch-jupyter-builder"]

# Then hatch build will invoke the jupyter-builder hook automatically

Requires Hatch as the build system and Python >= 3.8; the hook only activates when configured in a Hatch project's pyproject.toml.

Verify before relying:

- Whether the hook works with current Jupyter package standards and recent JupyterLab versions, given the dormant maintenance status.
- Compatibility with modern Hatch versions and any breaking changes in the Hatch plugin API since the last release.

## Package facts

- 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… (full text in the JSON record) (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: dormant
- Downloads: 188.0K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

hatch build hook jupyter, jupyter package build automation, hatch plugin jupyter packages, build jupyter extensions with hatch, jupyter build step hatch, jupyter package builder, hatch jupyter build hook, jupyter-ecosystem, build-automation, hatch-plugin

[View on SkillFed](https://skillfed.io/packages/hatch-jupyter-builder) · [View on PyPI](https://pypi.org/project/hatch-jupyter-builder/)