Merge pull request #175 from freemansw1/add-version-number

Adding version numbers

setup.py

@@ -1,8 +1,34 @@
 from setuptools import setup
 
+
+"""
+This code is from the python documentation and is
+designed to read in the version number.
+See: https://packaging.python.org/en/latest/guides/single-sourcing-package-version/
+"""
+from pathlib import Path
+
+
+def read(pkg_name):
+    init_fname = Path(__file__).parent / pkg_name / "__init__.py"
+    with open(init_fname, "r") as fp:
+        return fp.read()
+
+
+def get_version(pkg_name):
+    for line in read(pkg_name).splitlines():
+        if line.startswith("__version__"):
+            delim = '"' if '"' in line else "'"
+            return line.split(delim)[1]
+    else:
+        raise RuntimeError("Unable to find version string.")
+
+
+PACKAGE_NAME = "tobac"
+
 setup(
-    name="tobac",
-    version="1.3.3",
+    name=PACKAGE_NAME,
+    version=get_version(PACKAGE_NAME),
     description="Tracking and object-based analysis of clouds",
     url="http://github.com/tobac-project/tobac",
     author=[
@@ -22,7 +48,7 @@
         "[email protected]",
     ],
     license="BSD-3-Clause License",
-    packages=["tobac"],
+    packages=[PACKAGE_NAME],
     install_requires=[],
     zip_safe=False,
 )

tobac/__init__.py

@@ -61,3 +61,6 @@
 from .tracking import linking_trackpy
 from .wrapper import maketrack
 from .wrapper import tracking_wrapper
+
+# Set version number
+__version__ = "1.4.0"

tobac/tests/test_import.py

@@ -4,3 +4,18 @@
 
 def test_dummy_function():
     assert 1 == 1
+
+
+def test_version():
+    """Test to make sure that we have a version number included.
+    Also test to make sure that the version number complies with
+    semantic versioning guidelines.
+    If it's not, this should result in an error.
+    """
+    import re
+
+    assert type(tobac.__version__) is str
+    # Make sure that we are following semantic versioning
+    # i.e., our version is of form x.x.x, where x are all
+    # integer numbers.
+    assert re.match(r"[0-9]+\.[0-9]+\.[0-9]+", tobac.__version__) is not None