Merge branch 'feature/version-number' into develop

Author: RKrahl

.gitignore

@@ -2,7 +2,7 @@
 *~
 .cache/
 __pycache__/
-/.gitrevision
+/.version
 /MANIFEST
 /build/
 /dist/

MANIFEST.in

@@ -1,3 +1,4 @@
+include .version
 include LICENSE.txt
 include MANIFEST.in
 include README.rst

Makefile

@@ -8,10 +8,10 @@ build:
 test: build
 	PYTHONPATH=$(BUILDDIR)/lib $(PYTHON) -m pytest tests
 
-sdist: .gitrevision
+sdist:
 	$(PYTHON) setup.py sdist
 
-doc-html:
+doc-html: .version
 	$(MAKE) -C doc html
 
 clean:
@@ -23,13 +23,12 @@ distclean: clean
 	rm -rf .cache tests/.cache .pytest_cache tests/.pytest_cache
 	rm -f *.pyc tests/*.pyc
 	rm -rf __pycache__ tests/__pycache__
-	rm -f MANIFEST
+	rm -f MANIFEST .version
 	rm -rf dist
 	rm -rf pytest_dependency.egg-info
 	$(MAKE) -C doc distclean
 
-.gitrevision:
-	git describe --always --dirty > .gitrevision
+.version:
+	$(PYTHON) setup.py check
 
-
-.PHONY: build test sdist doc-html clean distclean .gitrevision
+.PHONY: build test sdist doc-html clean distclean

README.rst

@@ -24,6 +24,16 @@ System requirements
 + `setuptools`_.
 + `pytest`_ 3.6.0 or newer.
 
+Optional library packages:
+
++ `setuptools_scm`_
+
+  The version number is managed using this package.  All source
+  distributions add a static text file with the version number and
+  fall back using that if `setuptools_scm` is not available.  So this
+  package is only needed to build out of the plain development source
+  tree as cloned from GitHub.
+
 
 Installation
 ------------
@@ -79,3 +89,4 @@ permissions and limitations under the License.
 
 .. _setuptools: http://pypi.python.org/pypi/setuptools/
 .. _pytest: http://pytest.org/
+.. _setuptools_scm: https://github.com/pypa/setuptools_scm/

doc/src/changelog.rst

@@ -7,6 +7,7 @@ dev (not yet released)
 
     Bug fixes and minor changes
       + Issue #34: failing test with pytest 4.2.0 and newer.
+      + Use setuptools_scm to manage the version number.
 
 0.4 (2018-12-02)
     Incompatible changes

doc/src/conf.py

@@ -12,10 +12,10 @@
 import sys, os
 import os.path
 
-# Add the top source directory to the module path.  This file is
-# exec'ed with its directory as cwd.  This is "doc/src" relativ to the
-# top source directory.  So we need to go 2 dirs up.
-sys.path.insert(0,os.path.dirname(os.path.dirname(os.getcwd())))
+# The top source directory.  This file is exec'ed with its directory
+# as cwd.  This is "doc/src" relativ to the top source directory.  So
+# we need to go 2 dirs up.
+topdir = os.path.dirname(os.path.dirname(os.getcwd()))
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -50,11 +50,9 @@
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
-#
-# The short X.Y version.
-version = '0.4'
-# The full version, including alpha/beta/rc tags.
-release = '0.4.0'
+with open(os.path.join(topdir, ".version"), "rt") as f:
+    release = f.read()
+version = ".".join(release.split(".")[0:2])
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

pytest_dependency.py

@@ -1,7 +1,6 @@
 """$DOC"""
 
 __version__ = "$VERSION"
-__revision__ = "$REVISION"
 
 import pytest
 

setup.py

@@ -6,47 +6,43 @@
 skipped if any of the dependencies did fail or has been skipped.
 """
 
-__version__ = "0.4.0"
-
+import distutils.log
 import os
 import os.path
 import re
+import string
 from setuptools import setup
 import setuptools.command.sdist as st_sdist
+try:
+    import setuptools_scm
+    version = setuptools_scm.get_version()
+    with open(".version", "wt") as f:
+        f.write(version)
+except (ImportError, LookupError):
+    try:
+        with open(".version", "rt") as f:
+            version = f.read()
+    except (OSError, IOError):
+        distutils.log.warn("warning: cannot determine version number")
+        version = "UNKNOWN"
 
 
-def _filter_file(src, dest, subst):
-    """Copy src to dest doing substitutions on the fly.
-    """
-    substre = re.compile(r'\$(%s)' % '|'.join(subst.keys()))
-    def repl(m):
-        return subst[m.group(1)]
-    with open(src, "rt") as sf, open(dest, "wt") as df:
-        while True:
-            l = sf.readline()
-            if not l:
-                break
-            df.write(re.sub(substre, repl, l))
-
 class sdist(st_sdist.sdist):
     def make_release_tree(self, base_dir, files):
         st_sdist.sdist.make_release_tree(self, base_dir, files)
         if not self.dry_run:
             src = "pytest_dependency.py"
             dest = os.path.join(base_dir, src)
-            gitrevfile = ".gitrevision"
             if hasattr(os, 'link') and os.path.exists(dest):
                 os.unlink(dest)
-            subst = {'DOC': __doc__, 'VERSION': __version__}
-            if os.path.exists(gitrevfile):
-                with open(gitrevfile, "rt") as f:
-                    subst['REVISION'] = f.readline().strip()
-            _filter_file(src, dest, subst)
+            subst = {'DOC': __doc__, 'VERSION': version}
+            with open(src, "rt") as sf, open(dest, "wt") as df:
+                df.write(string.Template(sf.read()).substitute(subst))
 
 
 setup(
     name='pytest-dependency',
-    version=__version__,
+    version=version,
     description='Manage dependencies of tests',
     author='Rolf Krahl',
     author_email='[email protected]',