Merge pull request #121 from dnvgl/update-dynamic-versioning

Dev: update dynamic versioning

.gitignore

@@ -111,3 +111,6 @@ tmp*/*
 
 # Poetry
 poetry.lock
+
+# version file generated by poetry dynamic versioning 
+*/_version.py

docs/source/conf.py

@@ -4,7 +4,6 @@
 # qats documentation build configuration file, 
 # originally created by sphinx-quickstart
 #
-from importlib import metadata
 import os
 import sys
 # import the package to be documented
@@ -15,19 +14,7 @@
 THEME = 'furo'  # 'sphinx_rtd_theme'
 
 # determine qats version
-#
-# note: 
-#   As of v5.0.4, qats.__version__ returns "0.0.0" when in a an editable install 
-#   (e.g., if installed from repo using `poetry install` or `pip install -e .`). 
-#   This is, however, exactly the case when documentation is built for readthedocs.
-#   Therefore, qats version must be determined using importlib instead.
-# warning:
-#   importlib.metadata may be tricked if an old folder 'qats.egg-info' is present
-#   (e.g., originating from a previous call to `pip install -e .`). The version
-#   string obtained may then be outdated. However, it is safe to delete this old
-#   folder. Also, this should not be an issue when docs are built by readthedocs.
-__version__ = metadata.version("qats")
-
+__version__ = qats.__version__
 
 # print("Generating doc for QATS version {version} installed in {path}"
 #       .format(version=qats.__version__, path=qats.__path__))

pyproject.toml

@@ -10,7 +10,8 @@ license = "MIT"
 readme = "README.md"
 include = [
     "LICENSE",
-    "CHANGELOG.md"
+    "CHANGELOG.md",
+    "*/_version.py"
 ]
 # some urls given here instead of ulrs section (affects listed order on PyPi)
 homepage = "https://github.com/dnvgl/qats"
@@ -72,6 +73,14 @@ format-jinja = """
     {%- endif -%}
 """
 
+[tool.poetry-dynamic-versioning.files."qats/_version.py"]
+persistent-substitution = true
+initial-content = """
+# file generated by poetry dynamic versioning during poetry build/install
+# don't change, don't track in version control
+__version__ = "0.0.0"
+__version_tuple__ = (0, 0, 0)
+"""
 [build-system]
 # https://pypi.org/project/poetry-dynamic-versioning/
 requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning>=1.1.1,<2.0.0"]

qats/__init__.py

@@ -4,7 +4,13 @@
 """
 from .ts import TimeSeries
 from .tsdb import TsDB
-from ._version import __version__, __version_tuple__
+
+# version
+try:
+    from ._version import __version__, __version_tuple__
+except ImportError:
+    __version__ = "0.0.0"
+    __version_tuple__ = (0, 0, 0)
 
 # summary
 __summary__ = __doc__