Improvements to the versioning system

.dockerignore

@@ -0,0 +1,2 @@
+# Exclude the project virtual environment from image builds
+.venv

Dockerfile

@@ -11,6 +11,7 @@ RUN uv pip install wheel gssapi
 RUN uv pip install -r /code/requirements.txt
 
 COPY . .
+RUN uv build
 RUN uv pip install '.'
 
 CMD ["uvicorn", "nsls2api.main:app", "--proxy-headers", \

pyproject.toml

@@ -37,6 +37,12 @@ vcs = "git"
 style = "pep440"
 bump = true
 
+[tool.hatch.build.hooks.version]
+path = "src/nsls2api/_version.py"
+template = '''
+version = "{version}"
+'''
+
 [tool.hatch.build.targets.sdist]
 exclude = [
     "/.github",

src/nsls2api/__init__.py

@@ -1 +1,4 @@
+from .version import get_version
+
 __app_name__ = "nsls2api"
+__version__ = get_version()

src/nsls2api/infrastructure/app_setup.py

@@ -5,8 +5,10 @@
 
 from nsls2api.infrastructure import mongodb_setup
 from nsls2api.infrastructure.config import get_settings
+from nsls2api.infrastructure.logging import logger
 from nsls2api.services import background_service
 from nsls2api.services.helpers import httpx_client_wrapper
+from nsls2api.version import get_version
 
 settings = get_settings()
 
@@ -15,6 +17,9 @@
 
 @asynccontextmanager
 async def app_lifespan(app: FastAPI):
+    # Log the version of the nsls2api package
+    logger.info(f"NSLS-II API Version: {get_version()}")
+
     # Initialize the MongoDB connection
     await mongodb_setup.init_connection(settings.mongodb_dsn)
 

src/nsls2api/version.py

@@ -3,7 +3,13 @@
 
 def get_version() -> str:
     """Get the version of the nsls2api package"""
+
     try:
-        return importlib.metadata.version("nsls2api")
-    except importlib.metadata.PackageNotFoundError:
-        return "unknown"
+        from nsls2api._version import version
+
+        return version
+    except ImportError:
+        try:
+            return importlib.metadata.version("nsls2api")
+        except importlib.metadata.PackageNotFoundError:
+            return "0.0.0"  # Fallback version if the package is not found