Feat: version from git metadata (#382)

.devcontainer/Dockerfile

@@ -4,12 +4,10 @@ FROM eligibility_server:latest
 COPY docs/requirements.txt docs/requirements.txt
 RUN pip install --no-cache-dir -r docs/requirements.txt
 
+# copy files needed
+COPY .git .git
+COPY eligibility_server/ eligibility_server/
+COPY pyproject.toml pyproject.toml
+
 # install devcontainer requirements
 RUN pip install -e .[dev,test]
-
-# install pre-commit environments in throwaway Git repository
-# https://stackoverflow.com/a/68758943
-COPY .pre-commit-config.yaml .
-RUN git init . && \
-    pre-commit install-hooks && \
-    rm -rf .git

.devcontainer/devcontainer.json

@@ -5,6 +5,7 @@
   "service": "dev",
   "runServices": ["dev", "docs"],
   "workspaceFolder": "/home/calitp/app",
+  "postAttachCommand": ["/bin/bash", ".devcontainer/postAttach.sh"],
   "postStartCommand": ["/bin/bash", "bin/init.sh"],
   "customizations": {
     // Set *default* container specific settings.json values on container create.

.devcontainer/postAttach.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+set -eu
+
+pre-commit install --install-hooks

.dockerignore

@@ -1,5 +1,8 @@
-.git/
-.github/
-.vscode/
-.flake8
-.*ignore
+__pycache__/
+.pytest_cache/
+.coverage
+.DS_Store
+.env
+config/*
+!config/sample.py
+eligibility_server.egg-info

.vscode/settings.json

@@ -9,10 +9,7 @@
   "[python]": {
     "editor.defaultFormatter": "ms-python.black-formatter"
   },
-  "python.formatting.provider": "none",
   "python.languageServer": "Pylance",
-  "python.linting.enabled": true,
-  "python.linting.flake8Enabled": true,
   "python.testing.pytestArgs": ["tests"],
   "python.testing.pytestEnabled": true,
   "python.testing.unittestEnabled": false,

Dockerfile

@@ -1,17 +1,29 @@
-FROM ghcr.io/cal-itp/docker-python-web:main
+FROM ghcr.io/cal-itp/docker-python-web:main as build_wheel
 
-ENV FLASK_APP=eligibility_server/app.py
+WORKDIR /build
 
 # upgrade pip
 RUN python -m pip install --upgrade pip
 
+COPY . .
+RUN git config --global --add safe.directory /build
+
+# build as root user so unnecessary files are not copied into tarball
+USER root
+RUN pip install build && python -m build
+
+FROM ghcr.io/cal-itp/docker-python-web:main as appcontainer
+
+WORKDIR /home/calitp/app
+
+ENV FLASK_APP=eligibility_server.app:app
+
+COPY --from=build_wheel /build/dist /build/dist
+
 # copy source files
 COPY bin bin
-COPY eligibility_server/ eligibility_server/
-COPY pyproject.toml pyproject.toml
-
 # install source as a package
-RUN pip install -e .
+RUN pip install $(find /build/dist -name eligibility_server*.whl)
 
 # start app
 ENTRYPOINT ["/bin/bash"]

eligibility_server/app.py

@@ -4,15 +4,14 @@
 import logging
 
 from flask import Flask, jsonify, make_response
-from flask_restful import Api
 from flask.logging import default_handler
+from flask_restful import Api
 
-from eligibility_server import db, sentry
+from eligibility_server import __version__, db, sentry
 from eligibility_server.keypair import get_server_public_key
 from eligibility_server.settings import Configuration
 from eligibility_server.verify import Verify
 
-
 config = Configuration()
 
 app = Flask(__name__)
@@ -29,6 +28,7 @@
     # configure Flask's logger
     app.logger.setLevel(config.log_level)
     default_handler.formatter = logging.Formatter(format_string)
+    app.logger.info(f"Starting Eligibility Server {__version__}")
 
 
 def TextResponse(content):

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "eligibility-server"
-version = "2023.09.1"
+dynamic = ["version"]
 description = "Server implementation of the Eligibility Verification API"
 readme = "README.md"
 license = { file = "LICENSE" }
@@ -20,6 +20,7 @@ dev = [
     "black",
     "flake8",
     "pre-commit",
+    "setuptools_scm>=8"
 ]
 test = [
     "coverage",
@@ -33,7 +34,7 @@ Documentation = "https://docs.calitp.org/eligibility-server"
 Issues = "https://github.com/cal-itp/eligibility-server/issues"
 
 [build-system]
-requires = ["setuptools>=65", "wheel"]
+requires = ["setuptools>=65", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [tool.black]
@@ -51,3 +52,6 @@ include = ["eligibility_server", "tests"]
 
 [tool.setuptools]
 packages = ["eligibility_server"]
+
+[tool.setuptools_scm]
+# intentionally left blank, but we need the section header to activate the tool

tests/test_app.py

@@ -38,4 +38,4 @@ def test_version():
     from eligibility_server import __version__
 
     assert __version__ is not None
-    assert re.match(r"\d{4}\.\d{1,2}\.\d+", __version__)
+    assert re.match(r"\d+\.\d+\..+", __version__)