Merge pull request #86 from has2k1/tagged-releases

Use setuptools_scm for tagged versioning

Author: isabelizimm

MANIFEST.in

@@ -1 +0,0 @@
-include vetiver/data/*.csv

docs/source/conf.py

@@ -1,6 +1,7 @@
 import os
 import sys
-from vetiver import __version__
+import re
+from vetiver import __version__ as version
 
 sys.path.insert(0, os.path.abspath("."))
 
@@ -12,8 +13,14 @@
 author = "Isabel Zimmerman"
 
 # The full version, including alpha/beta/rc tags
-release = __version__
-
+# Do not use the 0.0 version created by setuptools_scm when the package
+# is cloned too shallow to pickup
+p = re.compile(r"^0\.0\.post\d+\+g")
+if p.match(version):
+    commit = p.sub("", version)
+    version = f"Commit: {commit}"
+
+release = version
 
 # -- General configuration ---------------------------------------------------
 

pyproject.toml

@@ -1,5 +1,9 @@
 [build-system]
-requires = ["setuptools>=45", "wheel"]
+requires = [
+    "setuptools>=59",
+    "setuptools_scm[toml]>=6.4",
+    "wheel"
+]
 build-backend = "setuptools.build_meta"
 
 [tool.pytest.ini_options]
@@ -9,3 +13,7 @@ doctest_optionflags = "NORMALIZE_WHITESPACE"
 markers = [
     "rsc_test: tests for rstudio connect",
 ]
+
+[tool.setuptools_scm]
+fallback_version = "999"
+version_scheme = 'post-release'

setup.cfg

@@ -35,6 +35,7 @@ install_requires =
     pins
     rsconnect-python
     plotly
+    importlib-metadata>=4.4  # NOTE: Remove when python_requires>=3.8
 
 [options.extras_require]
 dev =

setup.py

@@ -1,17 +1,4 @@
-import io
-import os
-import re
-
-from setuptools import find_packages
 from setuptools import setup
 
 
-def read(filename):
-    filename = os.path.join(os.path.dirname(__file__), filename)
-    text_type = type("")
-    with io.open(filename, mode="r", encoding="utf-8") as fd:
-        return re.sub(text_type(r":[a-z]+:`~?(.*?)`"), text_type(r"``\1``"), fd.read())
-
-
-if __name__ == "__main__":
-    setup()
+setup()

vetiver/__init__.py

@@ -1,10 +1,7 @@
 """vetiver - Python parallel to R vetiver package"""
+# Change to import.metadata when minimum python>=3.8
+from importlib_metadata import version as _version
 
-__version__ = "0.1.5"
-__author__ = "Isabel Zimmerman <isabel.zimmerman@rstudio.com>"
-__all__ = []
-
-import importlib  # noqa
 from .ptype import *  # noqa
 from .vetiver_model import VetiverModel  # noqa
 from .server import VetiverAPI, vetiver_endpoint, predict  # noqa
@@ -20,3 +17,8 @@
 from .handlers.torch import TorchHandler  # noqa
 from .rsconnect import deploy_rsconnect # noqa
 from .monitor import compute_metrics, pin_metrics, plot_metrics, _rolling_df # noqa
+
+__author__ = "Isabel Zimmerman <isabel.zimmerman@rstudio.com>"
+__all__ = []
+__version__ = _version("vetiver")
+del _version

vetiver/server.py

@@ -8,7 +8,6 @@
 import pandas as pd
 from typing import Callable, Union, List
 
-from . import __version__
 from .vetiver_model import VetiverModel
 from .utils import _jupyter_nb
 
@@ -180,11 +179,13 @@ def run(self, port: int = 8000, host: str = "127.0.0.1", **kw):
         uvicorn.run(self.app, port=port, host=host, **kw)
 
     def _custom_openapi(self):
+        import vetiver
+
         if self.app.openapi_schema:
             return self.app.openapi_schema
         openapi_schema = get_openapi(
             title=self.model.model_name + " model API",
-            version=__version__,
+            version=vetiver.__version__,
             description=self.model.description,
             routes=self.app.routes,
             servers=self.app.servers,