add tag base versioning mechanism

Author: ptooley

MANIFEST.in

@@ -1,3 +1,4 @@
+include pypop/version
 recursive-include pypop/examples *
 recursive-include pypop/cfgs *
 recursive-include pypop/cutters *

pypop/__init__.py

@@ -9,3 +9,11 @@
 from . import metrics
 from . import prv
 from . import config
+
+from .version import get_version
+
+__all__ = ['__version__']
+
+__version__ = get_version()
+
+

pypop/version.py

@@ -0,0 +1,48 @@
+#!/usr/bin/env python3
+
+from warnings import warn
+from pkg_resources import resource_filename
+from subprocess import run, PIPE
+
+_k_unknown_ver = "Unknown"
+
+def get_git_verstring():
+    git_result = run(
+        ['git', 'describe', '--tags', '--dirty', '--long'],
+        stdout=PIPE,
+        stderr=PIPE,
+    )
+    if git_result.returncode != 0:
+      return _k_unknown_ver
+
+    ver_string = git_result.stdout.decode().strip()
+    ver_tokens = ver_string.split('-')
+
+    dirty = None
+    if ver_tokens[-1] == "dirty":
+      dirty = ver_tokens.pop()
+
+    sha = ver_tokens.pop()
+    commitcount = ver_tokens.pop()
+    tag = '-'.join(ver_tokens)
+
+    if commitcount == '0':
+      return "-".join([tag, dirty]) if dirty else tag
+
+    return ver_string
+
+
+def get_version():
+
+  gitver = get_git_verstring()
+  if gitver != _k_unknown_ver:
+    return gitver
+  
+  try:
+    with open(resource_filename(__name__, 'version'), 'rt') as fh:
+      fileversion = fh.readlines().strip()
+      return fileversion
+  except FileNotFoundError:
+    pass
+    
+  return _k_unknown_ver

setup.py

@@ -3,10 +3,11 @@
 # Copyright (c) 2019, The Numerical Algorithms Group, Ltd. All rights reserved.
 
 from setuptools import setup, find_packages
+from versionate import versionate
 
 setup(
     name="pypop",
-    version="0.2.0rc8",
+    version=versionate(),
     url="https://github.com/numericalalgorithmsgroup/pypop.git",
     author="Numerical Algorithms Group",
     author_email="[email protected]",

versionate.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python3
+
+from warnings import warn
+from subprocess import run, PIPE
+
+_k_unknown_ver = "Unknown"
+
+
+def get_git_verstring():
+    git_result = run(
+        ['git', 'describe', '--tags', '--dirty', '--long'],
+        stdout=PIPE,
+        stderr=PIPE,
+    )
+    if git_result.returncode != 0:
+      warn("Git failed with error: {}".format(str(err.stderr)))
+      return _k_unknown_ver
+
+    ver_string = git_result.stdout.decode().strip()
+    ver_tokens = ver_string.split('-')
+
+    dirty = None
+    if ver_tokens[-1] == "dirty":
+      dirty = ver_tokens.pop()
+
+    sha = ver_tokens.pop()
+    commitcount = ver_tokens.pop()
+    tag = '-'.join(ver_tokens)
+
+    if commitcount == '0':
+      return "-".join([tag, dirty]) if dirty else tag
+
+    return ver_string
+
+
+def versionate():
+
+  ver_string = get_git_verstring()
+  
+  with open('pypop/version', 'wt') as fh:
+    fh.write(ver_string)
+
+  return ver_string
+
+
+if __name__ == "__main__":
+    print(get_git_verstring())