semver 2.9.1

Python helper for Semantic Versioning (http://semver.org/)

A Python module for semantic versioning. Simplifies comparing versions.

Note

With version 2.9.0 we’ve moved the GitHub project. The project is now located under the organization python-semver. The complete URL is:

https://github.com/python-semver/python-semver

If you still have an old repository, correct your upstream URL to the new URL:

$ git remote set-url upstream [e-mail]:python-semver/python-semver.git

The module follows the MAJOR.MINOR.PATCH style:

• MAJOR version when you make incompatible API changes,

• MINOR version when you add functionality in a backwards compatible manner, and

• PATCH version when you make backwards compatible bug fixes.

Additional labels for pre-release and build metadata are supported.

Warning

Major version 3.0.0 of semver will remove support for Python 2.7 and 3.4.

As anything comes to an end, this project will focus on Python 3.x. New features and bugfixes will be integrated only into the 3.x.y branch of semver.

The last version of semver which supports Python 2.7 and 3.4 will be 2.9.x. However, keep in mind, version 2.9.x is frozen: no new features nor backports will be integrated.

We recommend to upgrade your workflow to Python 3.x to gain support, bugfixes, and new features.

To import this library, use:

>>> import semver

Working with the library is quite straightforward. To turn a version string into the different parts, use the semver.parse function:

>>> ver = semver.parse('1.2.3-pre.2+build.4')
>>> ver['major']
1
>>> ver['minor']
2
>>> ver['patch']
3
>>> ver['prerelease']
'pre.2'
>>> ver['build']
'build.5'

To raise parts of a version, there are a couple of functions available for you. The semver.parse_version_info function converts a version string into a semver.VersionInfo class. The function semver.VersionInfo.bump_major leaves the original object untouched, but returns a new semver.VersionInfo instance with the raised major part:

>>> ver = semver.parse_version_info("3.4.5")
>>> ver.bump_major()
VersionInfo(major=4, minor=0, patch=0, prerelease=None, build=None)

It is allowed to concatenate different “bump functions”:

>>> ver.bump_major().bump_minor()
VersionInfo(major=4, minor=0, patch=1, prerelease=None, build=None)

To compare two versions, semver provides the semver.compare function. The return value indicates the relationship between the first and second version:

>>> semver.compare("1.0.0", "2.0.0")
-1
>>> semver.compare("2.0.0", "1.0.0")
1
>>> semver.compare("2.0.0", "2.0.0")
0

There are other functions to discover. Read on!