Skip to main content

releasecmd is a release subcommand for setup.py (setuptools.setup). the subcommand create a git tag and push, and upload packages to PyPI.

Project description

releasecmd

PyPI package version Supported Python versions

Summary

releasecmd is a release subcommand for setup.py (setuptools.setup). The subcommand create a git tag and push, and upload packages to PyPI.

The subcommand class (releasecmd.ReleaseCommand) is implemented as a subclass of setuptools.Command class. The release subcommand will do the followings:

  1. Find a file that defined the package version (e.g. <package>/__init__.py)
  2. Create .asc files if --sign option is specified
  3. Create a git tag from the package version information
    • GPG signing to the git tag if --sign option is specified
  4. Push git tags
  5. Upload package files to PyPI by using twine

release command options

Options for 'ReleaseCommand' command:
  --skip-tagging  skip a git tag creation
  --dry-run       do no harm
  --sign          make a GPG-signed tag
  --dir           specify a search root directory path. defaults to the
                  current directory.
  --tag-template  specify git tag format. defaults to 'v{version}'.
  --version       specify version manually

Example

$ python setup.py release
running release
[get the version from ./releasecmd/__version__.py]
[create a git tag: v0.0.15]
[push git tags]
[upload the package to PyPI]
...

prerequisite: package binaries must bein in the dist/ directory.

Specify version manually

You can specify a vesion manually by --version option:

$ python setup.py release --version 0.1.0
[create a git tag: v0.1.0]
[push git tags]
[upload packages to PyPI]

Create a GPG signed tag and upload packages

$ python setup.py release --sign
running release
[get the version from ./releasecmd/__version__.py]
[create a .asc file for releasecmd-0.1.0.tar.gz]
[create a .asc file for releasecmd-0.1.0-py2.py3-none-any.whl]
[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

$ python setup.py release --skip-tagging
running release
[get the version from ./releasecmd/__version__.py]
[push git tags]
[upload packages to PyPI]
...

Dependencies

  • Python 3.5+
  • git

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for releasecmd, version 0.4.0
Filename, size File type Python version Upload date Hashes
Filename, size releasecmd-0.4.0-py3-none-any.whl (5.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size releasecmd-0.4.0.tar.gz (6.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page