Merge pull request #510 from nexB/465-use-vcs-for-version

#465 Use setuptools-scm to get version with a git tag

Author: pombredanne

.gitignore

@@ -58,3 +58,4 @@ docs/_build
 /local/
 /share/
 /tcl/
+/.eggs/

setup.cfg

@@ -3,8 +3,7 @@ license_file = NOTICE
 
 [aliases]
 pypi_release = clean --all sdist --formats=bztar bdist_wheel register upload
-
-release = clean --all sdist --formats=gztar,bztar,zip bdist_wheel
+release = clean --all sdist --formats=bztar,zip bdist_wheel
 
 [pytest]
 norecursedirs =

setup.py

@@ -16,6 +16,59 @@
 from setuptools import setup
 
 
+version = '2.0.0rc3'
+
+
+def get_version(default=version, template='{tag}.{distance}.{commit}{dirty}'):
+    """
+    Return a version collected from git if possible or fall back to an hard-coded
+    version otherwise.
+    """
+    try:
+        tag, distance, commit, dirty = get_git_version()
+        if not distance and not dirty:
+            # we are from a clean Git tag: use tag
+            return tag
+
+        distance = 'post{}'.format(distance)
+        if dirty:
+            time_stamp = get_time_stamp()
+            dirty = '.dirty.' + get_time_stamp()
+        else:
+            dirty = ''
+
+        return template.format(**locals())
+    except:
+        # no git data: use default version
+        return default
+
+
+def get_time_stamp():
+    """
+    Return a numeric UTC time stamp without microseconds.
+    """
+    from datetime import datetime
+    return (datetime.isoformat(datetime.utcnow()).split('.')[0]
+            .replace('T', '').replace(':', '').replace('-', ''))
+
+
+def get_git_version():
+    """
+    Return version parts from Git or raise an exception.
+    """
+    from subprocess import check_output, STDOUT
+    # this may fail with exceptions
+    cmd = 'git', 'describe', '--tags', '--long', '--dirty',
+    version = check_output(cmd, stderr=STDOUT).strip()
+    dirty = version.endswith('-dirty')
+    tag, distance, commit = version.split('-')[:3]
+    # lower tag and strip V prefix in tags
+    tag = tag.lower().lstrip('v ').strip()
+    # strip leading g from git describe commit
+    commit = commit.lstrip('g').strip()
+    return tag, int(distance), commit, dirty
+
+
 def read(*names, **kwargs):
     return io.open(
         join(dirname(__file__), *names),
@@ -28,9 +81,10 @@ def read(*names, **kwargs):
     re.sub(':obj:`~?(.*?)`', r'``\1``', read('CHANGELOG.rst'))
 )
 
+
 setup(
     name='scancode-toolkit',
-    version='2.0.0rc3',
+    version=get_version(),
     license='Apache-2.0 with ScanCode acknowledgment and CC0-1.0 and others',
     description='ScanCode is a tool to scan code for license, copyright and other interesting facts.',
     long_description=long_description,

src/scancode/__init__.py

@@ -22,7 +22,8 @@
 #  ScanCode is a free software code scanning tool from nexB Inc. and others.
 #  Visit https://github.com/nexB/scancode-toolkit/ for support and download.
 
-__version__ = '2.0.0rc3'
+from __future__ import print_function
+from __future__ import absolute_import
 
 from os.path import dirname
 from os.path import abspath
@@ -33,6 +34,7 @@
 
 from commoncode import fileutils
 
+
 scan_src_dir = abspath(dirname(__file__))
 src_dir = dirname(scan_src_dir)
 root_dir = dirname(src_dir)
@@ -41,3 +43,11 @@
 
 if not exists(scans_cache_dir):
     fileutils.create_dir(scans_cache_dir)
+
+
+from pkg_resources import get_distribution, DistributionNotFound
+try:
+    __version__ = get_distribution('scancode-toolkit').version
+except DistributionNotFound:
+    # package is not installed ??
+    __version__ = '2.0.0rc3'

thirdparty/base/setuptools.ABOUT

@@ -7,5 +7,7 @@ download_url: https://pypi.python.org/packages/69/19/b1dff551058ce79d88b1e3688f1
 home_url: https://pypi.python.org/pypi/setuptools
 owner: Python Packaging Authority
 
-dje_license: psf
-license_text_file: PSF.LICENSE
+dje_license: psf and mit
+license_text_file: 
+    - PSF.LICENSE
+    - setuptools.LICENSE