Skip to main content

Version bumper and Python package releaser

Project description

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

Compatibility

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

Installation

You can install Bump'R with pip:

pip install bumpr

Usage

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

bumpr fake/__init__.py 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:

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

[bump]
unsuffix = true
message = Bump version {version}

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

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

[readthedoc]
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

Documentation

The documentation is hosted on Read the Docs:

Project details


Download files

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

Source Distribution

bumpr-0.3.8.tar.gz (16.4 kB view details)

Uploaded Source

Built Distribution

bumpr-0.3.8-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

Details for the file bumpr-0.3.8.tar.gz.

File metadata

  • Download URL: bumpr-0.3.8.tar.gz
  • Upload date:
  • Size: 16.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.14.14-arch1-1

File hashes

Hashes for bumpr-0.3.8.tar.gz
Algorithm Hash digest
SHA256 6bfdda629f7816012c0e3dcaca54b6228e25b2159956049639b329389f0348ad
MD5 f4d6a98040d7a289bba5260edfd04d32
BLAKE2b-256 02c0fc50c19972517e44b669f2bb66da7dc90027d98c0d7551282362aff60d77

See more details on using hashes here.

Provenance

File details

Details for the file bumpr-0.3.8-py3-none-any.whl.

File metadata

  • Download URL: bumpr-0.3.8-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.9.7 Linux/5.14.14-arch1-1

File hashes

Hashes for bumpr-0.3.8-py3-none-any.whl
Algorithm Hash digest
SHA256 1cdfe40b618d97ee3af07f74b3983c0bc5c68a369cc317995259e241438b93a6
MD5 3ffb9d61f8149c861293ec6b9249676f
BLAKE2b-256 6b6cb23a0f4804e04d30d4087d512e93734668fc16296fc4327c3a29cb11b0e1

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page