Skip to main content

Library and command line app to manage project releases or versions

Project description

Latest PyPI version Number of PyPI downloads Travis results Coveralls results_

Goal and Philosophy

Releaseme should ease the process of versioning a product and increment its version when required, despite the version is managed as a file or a repository tag.



Two options: to install it in your system/project:

pip install releaseme

And you can use it with:

python -m releaseme -h

Or just download the lastest zip and use it with:

python -h

Examples and FAQ

Let’s see an example. We have git project with a file in project/

__version__ = '2.3.4'

We want to manage versions with releaseme. And just a command is required:

$ python -m releaseme.__main__ --git --file project/

What does this?

  • Sets a git tag to 2.3.4
  • Upgrades the version in the file to ‘2.3.5’


This can seem a bit confusing at the beginning, but it is easy to explain: The git tag should mark the point where that version was launched, but the file should change to indicate the version we are working on.

This way, the file will always contain the next version to be used and the git tag, the point when it was released.

Can I set an explicit version?

Yes. Just edit the file with version and put the desired one.

What happens if there are different versions?

The higher one will be used.

What if I want to maintain several files?

Not a problem, because you can use:

$ python -m releaseme.__main__ --file project/

and it will set the same version for all of them.


Releaseme format is:

[-h] [-v] [--git] [--mercurial] [--file [FILE [FILE ...]]] [ACTION]

Where Action is any of get or increment. If none is provided, increment will be used:

  • get shows current version after processing all files.
  • increment will read the version and increment it in all files.


If you are using a Git repository, this will use git tags to get/set the version. No more arguments are required.

--hg or --mercurial

If you are using a Mercurial repository, this will use mercurial tags to get/set the version. No more arguments are required.


Allows you to select one or several files (space separated) to manage the version.

About the version number

Versions are up to 4 numbers separated by points. In addition, it can contain a hyphon (‘-‘) and an alphanumeric string at the end. So, valid version numbers are:

  • 1
  • 1.2
  • 1.2.3
  • 1-foo1
  • 1.2-foo1
  • 1.2.3-foo1

Version numbers that will not be managed correctly include:

  • 1-1
  • 1.a.1
  • 1.foo1

If more than one number is retrieved, the higher one will be used. So:

  • ‘1’ vs ‘1.2’ will use ‘1.2’
  • ‘’ vs ‘1.2’ will use ‘’
  • ‘1.2.1’ vs ‘1.3.0’ will use ‘1.3.0’

Finally, only the minor number will be incremented:

  • ‘1’ increments to ‘2’
  • ‘1.1’ increments to ‘1.2’
  • ‘1.1-foo1’ increments to ‘1.2-foo1’

Using it like a pro

The best way to use it is launching it just after releasing. So, the best way to do it is to add the releaseme call to your publishing script.

Why it doesn’t support NNNN technology?

Because I still didn’t require it. Please, feel free to add an issue and/or send a pull-request.


Copyright (c) 2014 Miguel Ángel García (@magmax9).

Licensed under the MIT license.

Project details

Release history Release notifications

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
releaseme-0.2.8-py2-none-any.whl (9.0 kB) Copy SHA256 hash SHA256 Wheel 2.7 Oct 17, 2014
releaseme-0.2.8.tar.gz (5.6 kB) Copy SHA256 hash SHA256 Source None Oct 17, 2014 (11.6 kB) Copy SHA256 hash SHA256 Source None Oct 17, 2014

Supported by

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