@ietf-tools/pypi-publish

Tool for publishing a Python package to PyPI from a GitHub Release

• Changelog
• Contributing
• Requirements
• Usage

---

This tool is a CLI which provides the following automation:

• Fetch the list of available repositories and releases
• Download the latest build of a Python package
• Install Twine (if not already installed)
• Sign and publish the package to PyPI (or TestPyPI)

Requirements

• Node.js 16.x or later
• Python 3.x

This tool assumes that you have the signing key used to sign Python packages already configured on your system. It will be used when publishing the package to PyPI.

Usage

Install the @ietf-tools/pypi-publish NPM package globally using:

npm install -g @ietf-tools/pypi-publish

Then run (from any location):

pypi-publish

Enter the necessary info as prompted.

CLI Arguments (optional)

These arguments can also be passed to the CLI to automate values and bypass the questions. All arguments are optional.

Short	Long	Description
-t TARGET	--target=TARGET	Target PyPI repository [pypi, testpypi]
-u USERNAME	--user=USERNAME	PyPI username
-p PASSWORD	--pass=PASSWORD	PyPI password
-i IDENTITY	--identity=IDENTITY	GPG identity to use for package signing
-g PROJECT	--project=PROJECT	GitHub project (repository) to publish from
-r RELEASE	--release=RELEASE	GitHub release to publish
	--python-path=PATH	Path to Python executable
-h	--help	Display usage + help message and exit
-v	--version	Display CLI version and exit

License

BSD-3-Clause

Changelog

[v1.0.6] - 2022-02-03

New Features

• efe26f8723 - check version on pypi before publish