Skip to content

Bump'R: Bump and release versions

Build Status codecov Documentation Status PyPI - Last version PyPI - License PyPI - Python Version

Bump'R is a version bumper and releaser allowing in a single command:

  • Clean-up release artifact
  • Bump version and tag it
  • Build a source distribution and upload on PyPI
  • Update version for a new development cycle

Bump'R intend to be customizable with the following features:

  • Optionnal test suite run before bump
  • Customizable with a config file
  • Overridable by command line
  • Extensible with hooks


Bump'R requires Python >=3.7 (and <4.0)


You can install Bump'R with pip:

pip install bumpr


You can use directly the command line to setup every parameter:

bumpr fake/ README.rst -M -ps dev

But Bump'R is designed to work with a configuration file (bumpr.rc by defaults). Some features are only availables with the configuration file like:

  • commit message customization
  • hooks configuration
  • multiline test, clean and publish commands

Here's an exemple:

file = fake/
vcs = git
tests = tox
publish = python sdist register upload
clean =
    python clean
    rm -rf *egg-info build dist
files = README.rst

unsuffix = true
message = Bump version {version}

suffix = dev
message = Prepare version {version} for next development cycle

file = CHANGELOG.rst
bump = {version} ({date:%Y-%m-%d})
prepare = In development

id = fake

This way you only have to specify which part you want to bump on the command line:

bumpr -M  # Bump the major
bumpr     # Bump the default part aka. patch


The documentation is hosted on Read the Docs:

Back to top