Use version.py instead of version.txt and add coverage.xml reporting

Author: MHendricks

.gitignore

@@ -8,7 +8,8 @@
 .tox/
 __pycache__/
 build/
+coverage.xml
 dist/
 htmlcov/
 venv/
-version.txt
+version.py

README.md

@@ -27,7 +27,7 @@ _Be sure to update the various properties so they pertain to your project._
 - Defines build system characteristics, more specifically those pertaining to `setuptools_scm` which provides automatic versioning based off git repo state.
 - Configures `pytest`.
 
-_The only property that will need updating is the `write_to` destination for the `version.txt`-file._
+_The only property that will need updating is the `write_to` destination for the `version.py`-file._
 
 > _While it would be ideal to fully migrate to `pyproject.toml` there are still several aspects of configuration that have not yet fully migrated to support the finalized [PEP 621] standard._
 

blur_python_example/__init__.py

@@ -0,0 +1 @@
+from .version import version as __version__  # noqa: F401

pyproject.toml

@@ -7,7 +7,7 @@ requires = [
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools_scm]
-write_to = "blur_python_example/version.txt"
+write_to = "blur_python_example/version.py"
 
 [tool.black]
 skip-string-normalization = true

setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = blur_python_example
-version = file: blur_python_example/version.txt
+version = file: blur_python_example/version.py
 description = Template python project for blurstudio developed packages.
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -59,9 +59,6 @@ dev =
     pytest
     tox
 
-[options.package_data]
-* = version.txt
-
 [bdist_wheel]
 universal = 1
 

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py{27,36,37,38,39},black,flake8
+envlist = begin,py{27,36,37,38,39},end,black,flake8
 skip_missing_interpreters = True
 skipsdist = True
 
@@ -14,9 +14,24 @@ deps =
     coverage
     pytest
 commands =
-    coverage erase
-    coverage run -m pytest {posargs:tests/}
+    # Ensure the version.py file is created
+    python setup.py egg_info
+
+    coverage run --append -m pytest {posargs:tests/}
+
+[testenv:begin]
+basepython = python3
+deps =
+    coverage
+commands = coverage erase
+
+[testenv:end]
+basepython = python3
+deps =
+    coverage
+commands =
     coverage report
+    coverage xml
 
 [testenv:black]
 basepython = python3