Making a new release of jupyterkernelclient

December 6, 2024 ยท View on GitHub

The extension can be published to PyPI manually or using the Jupyter Releaser.

Manual release

Python package

This repository can be distributed as Python package. All of the Python packaging instructions in the pyproject.toml file to wrap your extension in a Python package. Before generating a package, we first need to install build.

pip install build twine

To create a Python source package (.tar.gz) and the binary package (.whl) in the dist/ directory, do:

python -m build

Then to upload the package to PyPI, do:

twine upload dist/*

Automated releases with the Jupyter Releaser

Note

The extension repository is compatible with the Jupyter Releaser. But the GitHub repository and PyPI may need to be properly set up. Please follow the instructions of the Jupyter Releaser checklist.

Here is a summary of the steps to cut a new release:

  • Go to the Actions panel
  • Run the "Step 1: Prep Release" workflow
  • Check the draft changelog
  • Run the "Step 2: Publish Release" workflow

Note

Check out the workflow documentation for more information.

Publishing to conda-forge

If the package is not on conda forge yet, check the documentation to learn how to add it: https://conda-forge.org/docs/maintainer/adding_pkgs.html

Otherwise a bot should pick up the new version publish to PyPI, and open a new PR on the feedstock repository automatically.