releasecmd is a release subcommand for setup.py (setuptools.setup). the subcommand creates a git tag and pushes and uploads packages to PyPI.
Project description
releasecmd
Summary
releasecmd is a release subcommand for setup.py (setuptools.setup). The subcommand creates a git tag and pushes and uploads packages to PyPI.
The subcommand class (releasecmd.ReleaseCommand) is implemented as a subclass of setuptools.Command class. The release subcommand performs the following tasks:
- Detect the package version
If specified with the --version option, use that version
Retrieve the package version from an installed package if the --use-installed-version option is specified
Find a file that defines the package version (__version__ variable)
- Creates a git tag using the package version information
Optionally signs the git tag with GPG if the --sign option is specified
Pushes the git tag
Upload package files to PyPI using twine.
Installation
pip install releasecmd
Usage
- setup.py:
import setuptools from releasecmd import ReleaseCommand setuptools.setup( ... cmdclass={"release": ReleaseCommand}, )
Example
$ python3 setup.py release
running release
[get the version from ./releasecmd/__version__.py]
[pull git tags]
Already up to date.
[check existing git tags]
[create a git tag: v0.0.15]
[push git tags]
[upload the package to PyPI]
...prerequisite: package binaries must be in the dist/ directory.
Specify version manually
You can specify a version manually by --version option:
$ python3 setup.py release --version 0.1.0
[create a git tag: v0.1.0]
[pull git tags]
Already up to date.
[check existing git tags]
[push git tags]
[upload packages to PyPI]Create a GPG signed tag and upload packages
$ python3 setup.py release --sign
running release
[get the version from ./releasecmd/__version__.py]
[pull git tags]
Already up to date.
[check existing git tags]
[create a git tag with gpg signing: v0.1.0]
[push git tags]
[upload packages to PyPI]
...Skip create a git tag and upload packages
$ python3 setup.py release --skip-tagging
running release
[get the version from ./releasecmd/__version__.py]
skip git tagging
[upload packages to PyPI]
...release command options
Options for 'ReleaseCommand' command:
--skip-tagging skip a git tag creation
--skip-uploading skip uploading packages to PyPI
--dry-run don't actually do anything
--sign make a GPG-signed git tag
--verbose show verbose output
--search-dir specify a root directory path to search a version
file. defaults to the current directory.
--tag-template specify git tag format. defaults to 'v{version}'
--use-installed-version use an installed package version as a release
version
--version specify release version
Dependencies
Python 3.8+
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for releasecmd-0.10.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 04ff3f4c70ee7ce05c1cb47ac27d74fb3dc45a401b2cc41042a2153a5afd9a79 |
|
| MD5 | e1ea496edfa930dccd005e4d55045d63 |
|
| BLAKE2b-256 | f6712747ddb5124a9f3237839f9e4d958038e3021295921a8c1a2d77814dc0f1 |
