Automatically determine version from git tag

Author: jvanstraten

setup.py

@@ -4,19 +4,12 @@
 import re
 from setuptools import setup
 from setuptools.command.test import test as TestCommand
+from setuptools.command.build_py import build_py as BuildCommand
 
 def read(fname):
     with open(os.path.join(os.path.dirname(__file__), fname)) as fildes:
         return fildes.read()
 
-def get_version():
-    with open('vhdeps/__init__.py', 'r') as fildes:
-        for line in fildes:
-            match = re.match("__version__ = '([^']+)'\n", line)
-            if match:
-                return match.group(1)
-    raise ValueError('Could not find package version')
-
 class NoseTestCommand(TestCommand):
     def finalize_options(self):
         TestCommand.finalize_options(self)
@@ -28,25 +21,37 @@ def run_tests(self):
         import nose
         nose.run_exit(argv=['nosetests'])
 
+class BuildWithVersionCommand(BuildCommand):
+    def run(self):
+        if not self.dry_run:
+            version_fname = os.path.join(self.build_lib, 'vhdeps', 'version.py')
+            with open(version_fname, 'w') as fildes:
+                fildes.write('__version__ = """' + self.distribution.metadata.version + '"""\n')
+
+        BuildCommand.run(self)
+
 setup(
-    name = "vhdeps",
-    version = get_version(),
-    author = "Jeroen van Straten",
-    author_email = "[email protected]",
+    name = 'vhdeps',
+    version_config={
+        'version_format': '{tag}+{sha}',
+        'starting_version': '0.0.1'
+    },
+    author = 'Jeroen van Straten',
+    author_email = '[email protected]',
     description = (
-        "VHDL dependency analyzer and simulation driver."
+        'VHDL dependency analyzer and simulation driver.'
     ),
-    license = "Apache",
-    keywords = "vhdl dependency analyzer simulation",
-    url = "https://github.com/abs-tudelft/vhdeps",
+    license = 'Apache',
+    keywords = 'vhdl dependency analyzer simulation',
+    url = 'https://github.com/abs-tudelft/vhdeps',
     long_description = read('README.md'),
     long_description_content_type = 'text/markdown',
     classifiers = [
-        "Development Status :: 3 - Alpha",
-        "Intended Audience :: Developers",
-        "Topic :: Software Development :: Build Tools",
-        "License :: OSI Approved :: Apache Software License",
-        "Programming Language :: Python :: 3",
+        'Development Status :: 3 - Alpha',
+        'Intended Audience :: Developers',
+        'Topic :: Software Development :: Build Tools',
+        'License :: OSI Approved :: Apache Software License',
+        'Programming Language :: Python :: 3',
     ],
     project_urls = {
         'Source': 'https://github.com/abs-tudelft/vhdeps',
@@ -55,7 +60,14 @@ def run_tests(self):
     entry_points = {'console_scripts': ['vhdeps=vhdeps:run_cli']},
     python_requires = '>=3',
     install_requires = ['plumbum'],
-    setup_requires = ['setuptools-lint', 'pylint'],
+    setup_requires = [
+        'better-setuptools-git-version',
+        'setuptools-lint',
+        'pylint'
+    ],
     tests_require = ['nose', 'coverage'],
-    cmdclass = {'test': NoseTestCommand},
+    cmdclass = {
+        'test': NoseTestCommand,
+        'build_py': BuildWithVersionCommand,
+    },
 )

vhdeps/__init__.py

@@ -22,8 +22,7 @@
 import argparse
 import vhdeps.vhdl as vhdl
 import vhdeps.target as target_mod
-
-__version__ = '0.0.4'
+from vhdeps.version import __version__
 
 def run_cli(args=None):
     """Runs the vhdeps CLI. The command-line arguments are taken from `args`

vhdeps/version.py

@@ -0,0 +1,4 @@
+"""Version metadata file. This file is overridden by setuptools with the
+actual version when the module is "built"."""
+
+__version__ = 'not-installed'