Skip to main content

Version bumper and Python package releaser

Project description

Build status Code coverage Requirements Status Documentation status License Supported Python versions

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 2.6+

Installation

You can install Bump’R with pip:

$ pip install bumpr

or with easy_install:

$ easy_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

Changelog

0.3.1 (2017-01-08)

  • Ensure push is executed

  • Fix boolean parsing

  • Fix error handling on version extraction

0.3.0 (2017-01-08)

  • Support seprator omission in changelog (for markdown)

  • Add readthedoc badge support.

  • Breaking Use https and readthedocs.io as default

  • setup.cfg declaration support

  • Optionnal bumpr: prefix support

  • Switch to pytest

0.2.1 (2015-11-21)

  • Use nosetests instead of custom discovery

  • Some fixes on Python 3 (mostly encodings)

  • Improve error handling

  • Validate configuration

0.2.0 (2013-08-24)

  • colored diff

  • Added --bump and --prepare to only perform bump or prepare

  • Rely on VCS for tracking files and ensure working copy is clean

  • Added option --nocommit

  • Ensure dry run does not write or execute anything

  • Better output and error handling

  • Group parameters in help

  • Added optionnal hook vaidation

  • Fix some Python incompatibilities (Python 2.6 and 3.X)

  • More documentation

0.1.0 (2013-08-22)

  • Initial release. Missing some parts but working!

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.1.tar.gz (14.5 kB view details)

Uploaded Source

Built Distribution

bumpr-0.3.1-py2.py3-none-any.whl (16.5 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

  • Download URL: bumpr-0.3.1.tar.gz
  • Upload date:
  • Size: 14.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for bumpr-0.3.1.tar.gz
Algorithm Hash digest
SHA256 dd9055da13959d4b36e0bda68659c8fb6c319828ab9fa4d77e8376300e52248d
MD5 0e7322ea1daf2ffc74574eb8357e8a5f
BLAKE2b-256 2b61e7314d5d3095d3b9c3b5e9dcf9cb0581d9c0439a29c675ac8180c9e91722

See more details on using hashes here.

File details

Details for the file bumpr-0.3.1-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for bumpr-0.3.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0c99d7749e7f6684d3c6254c5a6bc81d8521c251e79719c472c0cc59ec477108
MD5 fd5f9912895f2431a29ae355a7e51c8e
BLAKE2b-256 24642be17bfbcbaab80533b6767cf63597a5f20c6f6ff1b9d7454ad65923d7a8

See more details on using hashes here.

Supported by

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