pavement.py

+import sys
+
+from paver.easy import task, needs, path, sh, cmdopts, options
+from paver.setuputils import setup, install_distutils_tasks, find_packages
+from distutils.extension import Extension
+from distutils.dep_util import newer
+
+sys.path.insert(0, path('.').abspath())
+import version
+
+setup(name='dstat_interface',
+      version=version.getVersion(),
+      description='Interface software for DStat potentiostat.',
+      keywords='',
+      author='Michael D. M Dryden',
+      author_email='mdryden@chem.utoronto.ca',
+      url='http://microfluidics.utoronto.ca/dstat',
+      license='GPLv3',
+      packages=find_packages(),
+      install_requires=['matplotlib', 'numpy', 'pyserial', 'pyzmq',
+                        'pyyaml','seaborn', 'setuptools', 
+                        'zmq-plugin>=0.2.post2'],
+      # Install data listed in `MANIFEST.in`
+      include_package_data=True)
+
+
+@task
+@needs('generate_setup', 'minilib', 'setuptools.command.sdist')
+def sdist():
+    """Overrides sdist to make sure that our setup.py is generated."""
+    pass

version.py

+# -*- coding: utf-8 -*-
+
+"""Calculates the current version number.
+
+If possible, uses output of “git describe” modified to conform to the
+visioning scheme that setuptools uses (see PEP 386).  Releases must be
+labelled with annotated tags (signed tags are annotated) of the following
+format:
+
+   v<num>(.<num>)+ [ {a|b|c|rc} <num> (.<num>)* ]
+
+If “git describe” returns an error (likely because we're in an unpacked copy
+of a release tarball, rather than a git working copy), or returns a tag that
+does not match the above format, version is read from RELEASE-VERSION file.
+
+To use this script, simply import it your setup.py file, and use the results
+of getVersion() as your package version:
+
+    import version
+    setup(
+        version=version.getVersion(),
+        .
+        .
+        .
+    )
+
+This will automatically update the RELEASE-VERSION file.  The RELEASE-VERSION
+file should *not* be checked into git but it *should* be included in sdist
+tarballs (as should version.py file).  To do this, run:
+
+    echo include RELEASE-VERSION version.py >>MANIFEST.in
+    echo RELEASE-VERSION >>.gitignore
+
+With that setup, a new release can be labelled by simply invoking:
+
+    git tag -s v1.0
+"""
+
+__author__ = ('Douglas Creager <dcreager@dcreager.net>',
+              'Michal Nazarewicz <mina86@mina86.com>')
+__license__ = 'This file is placed into the public domain.'
+__maintainer__ = 'Michal Nazarewicz'
+__email__ = 'mina86@mina86.com'
+
+__all__ = ('getVersion')
+
+
+import re
+import subprocess
+import sys
+import os.path
+import inspect
+
+RELEASE_VERSION_FILE = '{}/RELEASE-VERSION'.format(
+    os.path.dirname(os.path.abspath(inspect.stack()[0][1])))
+
+# http://www.python.org/dev/peps/pep-0386/
+_PEP386_SHORT_VERSION_RE = r'\d+(?:\.\d+)+(?:(?:[abc]|rc)\d+(?:\.\d+)*)?'
+_PEP386_VERSION_RE = r'^%s(?:\.post\d+)?(?:\.dev\d+)?$' % (
+    _PEP386_SHORT_VERSION_RE)
+_GIT_DESCRIPTION_RE = r'^v(?P<ver>%s)-(?P<commits>\d+)-g(?P<sha>[\da-f]+)$' % (
+    _PEP386_SHORT_VERSION_RE)
+
+
+def readGitVersion():
+    try:
+        proc = subprocess.Popen(('git', 'describe', '--long',
+                                 '--match', 'v[0-9]*.*'),
+                                stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        data, _ = proc.communicate()
+        if proc.returncode:
+            return None
+        ver = data.splitlines()[0].strip()
+        proc = subprocess.Popen(('git', 'rev-parse', '--abbrev-ref', 'HEAD'),
+                                stdout=subprocess.PIPE, stderr=subprocess.PIPE)
+        branch, _ = proc.communicate()
+        if proc.returncode:
+            return None
+    except:
+        return None
+
+    if not ver:
+        return None
+    m = re.search(_GIT_DESCRIPTION_RE, ver)
+    if not m:
+        sys.stderr.write('version: git description (%s) is invalid, '
+                         'ignoring\n' % ver)
+        return None
+
+    commits = int(m.group('commits'))
+
+    if not commits:
+        version = m.group('ver')
+    else:
+        version = '%s.post%d' % (
+            m.group('ver'), commits)
+
+    if branch.strip() != 'master':
+        version += '.dev%d' % int(m.group('sha'), 16)
+
+    return version
+
+
+def readReleaseVersion():
+    try:
+        fd = open(RELEASE_VERSION_FILE)
+        try:
+            ver = fd.readline().strip()
+        finally:
+            fd.close()
+        if not re.search(_PEP386_VERSION_RE, ver):
+            sys.stderr.write('version: release version (%s) is invalid, '
+                             'will use it anyway\n' % ver)
+        return ver
+    except:
+        return None
+
+
+def writeReleaseVersion(version):
+    fd = open(RELEASE_VERSION_FILE, 'w')
+    fd.write('%s\n' % version)
+    fd.close()
+
+
+def getVersion():
+    release_version = readReleaseVersion()
+    version = readGitVersion() or release_version
+    if not version:
+        raise ValueError('Cannot find the version number')
+    if version != release_version:
+        writeReleaseVersion(version)
+    return version
+
+
+if __name__ == '__main__':
+    print getVersion()
+