Skip to main content

Simple git tag based version numbers

Project description

https://img.shields.io/pypi/v/versiontag.svg https://img.shields.io/pypi/dm/versiontag.svg https://travis-ci.org/crgwbr/python-versiontag.svg

What?

This is an ultra-simple library design to make accessing the current version number of your software easy.

Why?

Version numbers are all too often duplicated among setup.py, git tags, and others sources of truth. This library makes it possible to consolidate on git tags as a single source of truth regarding version numbers.

How?

Install python-versiontag using pip.

pip install versiontag

Add version.txt to your .gitignore file.

echo "version.txt" >> .gitignore

Add versiontag to your package’s setup.py file.

from versiontag import get_version, cache_git_tag

# This caches for version in version.txt so that it is still accessible if
# the .git folder disappears, for example, after the slug is built on Heroku.
cache_git_tag()

setup(name='My Package',
      version=get_version(pypi=True),
...

Use versiontag where ever you want to access the version number.

>>> from versiontag import get_version
>>> print( get_version() )
'r1.2.3'

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

versiontag-1.0.1.tar.gz (2.5 kB view hashes)

Uploaded Source

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