Metadata-Version: 2.0
Name: versiontag
Version: 1.1.0
Summary: Simple git tag based version numbers
Home-page: https://github.com/thelabnyc/python-versiontag
Author: Craig Weber
Author-email: crgwbr@gmail.com
License: ISC
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: ISC License (ISCL)
Classifier: Operating System :: Unix
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5

python-versiontag
=============================

|  |license| |kit| |format| |downloads| |travisci|

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.

.. code:: bash

    pip install versiontag

Add version.txt to your .gitignore file.

.. code:: bash

    echo "version.txt" >> .gitignore

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

.. code:: python

    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.

.. code:: python

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



.. |license| image:: https://img.shields.io/pypi/l/versiontag.svg
    :target: https://pypi.python.org/pypi/versiontag
.. |kit| image:: https://badge.fury.io/py/versiontag.svg
    :target: https://pypi.python.org/pypi/versiontag
.. |format| image:: https://img.shields.io/pypi/format/versiontag.svg
    :target: https://pypi.python.org/pypi/versiontag
.. |downloads| image:: https://img.shields.io/pypi/dm/versiontag.svg?maxAge=2592000
    :target: https://pypi.python.org/pypi/versiontag
.. |travisci| image:: https://travis-ci.org/thelabnyc/python-versiontag.svg
    :target: https://travis-ci.org/thelabnyc/python-versiontag


