Skip to main content

publish - Tool to create a release of a Python package

Build Status Codacy Quality Badge Codacy Coverage Badge

publish is a tool to package and release a python project. It will create a changelog and upload artifacts to Github and PyPI.

It is created for and by the FIAAS project, and used for most of our projects.

Usage

In order to use publish, you must first install it:

pip install publish

Under the covers, publish uses github-release and twine to do most of the work, and those tools require credentials for Github and PyPI to be available in environment variables:

export GITHUB_TOKEN=gh-token
export TWINE_USERNAME=pypi-user
export TWINE_PASSWORD=pypi-pass

In order to know where to upload the artifacts, you must specify an organization, and a repository:

publish fiaas k8s

Before uploading anything, publish will verify that the current checkout is suitable to be released, and checks the following items:

  • Are all files either ignored or in version control?

  • Is every change committed?

  • Is the currently checked out code tagged with an annotated tag?

  • Does that tag use the convention v<major>.<minor>.<bugfix>?

If the answer to all of these is yes, the name of the tag is used as the version to release. A changelog is generated from the git log, source tarballs and wheels are built, the release is created in Github and PyPI, and the files are uploaded.

Changes since last version

  • ec150cb: Change name to fiaas-publish, and use githubrelease library

  • 8569bc2: Set a returncode to reflect errors when uploading artifacts

  • a2879ac: Bump versions of dependencies

Metadata

Release files for fiaas-publish 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for fiaas-publish 0.2.0
File Size Uploaded
fiaas-publish-0.2.0.tar.gz 13.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for fiaas-publish 0.2.0
File Interpreter ABI Platform
fiaas_publish-0.2.0-py2.py3-none-any.whl Python 2, Python 3 none any Details

Total release size: 19.5 kB

Release files / fiaas-publish-0.2.0.tar.gz

Download URL fiaas-publish-0.2.0.tar.gz
Size 13.5 kB
Tags Source
SHA-256 checksum
How to use checksums
39705b2363642dafdb89145d2d4447966c4687815eed78d09690bc5efc0b9bb9
BLAKE2b-256 checksum
How to use checksums
3ecb7caed81977b0c0be5ed7c33c7ac7d2810b2d7c9a815e03dd9cbd5319ecb5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.4.3

Release files / fiaas_publish-0.2.0-py2.py3-none-any.whl

Download URL fiaas_publish-0.2.0-py2.py3-none-any.whl
Size 6.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
64a0ad0bfb8343bfe12bffdb54e931c3ae5d3ea8a65249b0ebd7fd66653b0914
BLAKE2b-256 checksum
How to use checksums
2f82768b045ed80d45ad57342d9115be17e19b81ac8ad87f4075d332f2252a8e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.12.1 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.29.0 CPython/3.4.3

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page