Merge pull request #1148 from adamtheturtle/scm-setuptools

Swap versioneer for scm_setuptools

Author: adamtheturtle

.git_archival.txt

@@ -0,0 +1 @@
+ref-names: $Format:%D$

.gitattributes

@@ -1 +1 @@
-src/vws/_version.py export-subst
+.git_archival.txt  export-subst

.gitignore

@@ -106,3 +106,6 @@ secrets.tar
 
 # pytest
 .pytest_cache/
+
+# setuptools_scm
+src/*/_setuptools_scm_version.txt

docs/source/conf.py

@@ -32,7 +32,8 @@
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 version = vws.__version__
-release = version.split('+')[0]
+_month, _day, _year, *_ = version.split('.')
+release = f'{_month}.{_day}.{_year}'
 
 substitutions = [
     ('|release|', release),

lint.mk

@@ -7,22 +7,20 @@ yapf:
 	yapf \
 	    --diff \
 	    --recursive \
-	    --exclude versioneer.py  \
-	    --exclude src/*/_version.py \
+	    --exclude .eggs \
 	    .
 
 .PHONY: fix-yapf
 fix-yapf:
 	yapf \
 	    --in-place \
 	    --recursive \
-	    --exclude versioneer.py  \
-	    --exclude src/*/_version.py \
+	    --exclude .eggs \
 	    .
 
 .PHONY: mypy
 mypy:
-	mypy *.py src/ tests/ docs/source/
+	mypy *.py src/ tests/ docs/source/ admin
 
 .PHONY: check-manifest
 check-manifest:
@@ -58,7 +56,7 @@ pyroma:
 
 .PHONY: vulture
 vulture:
-	vulture --min-confidence 100 --exclude _vendor .
+	vulture --min-confidence 100 --exclude _vendor --exclude .eggs .
 
 .PHONY: linkcheck
 linkcheck:
@@ -80,7 +78,7 @@ autoflake:
 	    --remove-all-unused-imports \
 	    --remove-unused-variables \
 	    --expand-star-imports \
-	    --exclude _vendor,src/*/_version.py,versioneer.py,release \
+	    --exclude _vendor,release \
 	    .
 
 .PHONY: pydocstyle

requirements.txt

@@ -2,3 +2,4 @@ VWS-Auth-Tools==2019.12.27.1
 requests==2.22.0
 timeout-decorator==0.4.1
 urllib3==1.25.7
+setuptools-scm==3.3.3

setup.cfg

@@ -23,6 +23,7 @@ ignore =
     doc8.ini
     docs
     docs/*
+    .git_archival.txt
     mypy.ini
     pylintrc
     pytest.ini
@@ -34,27 +35,15 @@ ignore =
     lint.mk
 
 [flake8]
-exclude=./versioneer.py,
-        ./src/vws/_version.py,
+exclude=./.eggs,
         ./build/,
 
-# See the docstring in versioneer.py for instructions. Note that you must
-# re-run 'versioneer.py setup' after changing this section, and commit the
-# resulting files.
-[versioneer]
-VCS = git
-style = pep440
-versionfile_source = src/vws/_version.py
-versionfile_build = vws/_version.py
-tag_prefix =
-parentdir_prefix = vws
-
 [bdist_wheel]
 universal = 1
 
 [doc8]
 max-line-length = 2000
-ignore-path = ./src/*.egg-info/SOURCES.txt,./docs/build/spelling/output.txt
+ignore-path = ./src/*.egg-info/SOURCES.txt,./docs/build/spelling/output.txt,./.eggs,src/*/_setuptools_scm_version.txt
 
 [tool:pytest]
 xfail_strict=true
@@ -78,12 +67,6 @@ warn_return_any = True
 warn_unused_configs = True
 warn_unused_ignores = True
 
-[mypy-vws/_version]
-ignore_errors = True
-
-[mypy-versioneer]
-ignore_errors = True
-
 [pydocstyle]
 # No summary lines
 #   - D200
@@ -104,17 +87,13 @@ ignore_errors = True
 # Do not care about imperative mood
 #   - D401
 ignore = D200,D202,D203,D205,D212,D400,D406,D407,D413,D401,D415
-match=(?!.*(versioneer|test_|_version)).*\.py
 
 [isort]
 multi_line_output=3
 include_trailing_comma=true
 
 [coverage:run]
 branch = True
-omit =
-    *_vendor*
-    src/*/_version.py
 
 [yapf]
 DEDENT_CLOSING_BRACKETS = true

setup.py

@@ -5,8 +5,6 @@
 
 from setuptools import setup
 
-import versioneer
-
 
 def _get_dependencies(requirements_file: Path) -> List[str]:
     """
@@ -27,8 +25,10 @@ def _get_dependencies(requirements_file: Path) -> List[str]:
 )
 
 setup(
-    version=versioneer.get_version(),  # type: ignore
-    cmdclass=versioneer.get_cmdclass(),  # type: ignore
+    use_scm_version={
+        'write_to': 'src/vws/_setuptools_scm_version.txt',
+    },
+    setup_requires=['setuptools_scm', 'setuptools_scm_git_archive'],
     install_requires=INSTALL_REQUIRES,
     extras_require={'dev': DEV_REQUIRES},
 )

src/vws/__init__.py

@@ -2,7 +2,10 @@
 A library for Vuforia Web Services.
 """
 
-from ._version import get_versions
+from pathlib import Path
+
+from setuptools_scm import get_version
+
 from .query import CloudRecoService
 from .vws import VWS
 
@@ -11,5 +14,11 @@
     'VWS',
 ]
 
-__version__ = get_versions()['version']  # type: ignore
-del get_versions
+try:
+    __version__ = get_version(root='..', relative_to=Path(__file__).parent)
+except LookupError:  # pragma: no cover
+    # When pkg_resources and git tags are not available,
+    # for example in a PyInstaller binary,
+    # we write the file ``_setuptools_scm_version.py`` on ``pip install``.
+    _VERSION_FILE = Path(__file__).parent / '_setuptools_scm_version.txt'
+    __version__ = _VERSION_FILE.read_text()