Skip to main content

Simple semantic-version bumper in python that works.

Project description

Current version: 1.0.0

Compatible with Python >=2.7

BumpyTrack

Bumping the (semantic) version of your software every time a release is done can be a tedious task, if you:

  • Have the version written in various files, e.g. setup.py or a dedicated version file.
  • Manage versioning with tags in GIT.

This little script automates this process for you.

Say you're using git-flow and you've just merged a feature to your development branch. You can just checkout and pull it, and then do:

bumpytrack minor  # or major if you have breaking changes, or patch if it's a simple bugfix

It will:

  • Replace the version string in all relevant files (see config below).
  • Commit those changes to GIT, taking care not to commit anything else.
  • Create a GIT tag for this new version.

Now you're free to push, merge to master and deploy!

For the above version string replacements we'll need some config. This example should be autoexplicative. Save it as pyproject.toml in the root of your repository and you're good to go.

Installation

pip install bumpytrack

Then add a pyproject.toml to the root of your repository and configure it like this.

Help

The script is really simple, and has a decent on-line documentation. Just do:

bumpytrack --help

Some of the available options:

  --current-version CURRENT_VERSION
                        Force current version instead using version in config
                        file.
  --new-version NEW_VERSION
                        Force new version instead using version in config
                        file.
  --git-commit          GIT: Commit files with version replacements.
  --no-git-commit
  --git-tag             GIT: Tag this reference with the new version.
  --no-git-tag
  --config-path CONFIG_PATH
                        Path to config file. Defaults to pyproject.toml in
                        current directory.
  --verbose

You can also just peek at the code. Not much of it... it just adds one to some little numbers ;p

Development

Make sure you have the lastest pip and pipenv versions:

pip install --update pip pipenv

To start developing, start the environment by:

pipenv shell
pipenv install -d

This tool uses both pipenv for development and setuptools for packaging and distribution. To this date there is not a 100% community-accepted best practice so I've taken this approach. In summary:

To add an application dependency, add it in setup.py and leave it with a loose version definition. Then, just do pipenv install -e . to install the dependency. Pipenv locking mecanism will work as expected, since bumpytrack itself in in the [packages] section of Pipfile (check Pipfile.lock and you'll find the deps there).

To add a development dependency, add it to Pipfile via pipenv install -d <my-dependency>.

This way there's a single source of truth for package definition. No need to repeat the deps in setup.py and Pipfile*.

Also, dev project tasks are managed using nandilugio/pepython. See the tasks defined in tasks.py.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

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

Files for bumpytrack, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size bumpytrack-1.0.0-py2-none-any.whl (6.3 kB) File type Wheel Python version py2 Upload date Hashes View hashes
Filename, size bumpytrack-1.0.0.tar.gz (5.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page