Lean on hatch-vcs for managing the package version (#28)

Author: kgaughan

.github/workflows/release.yml

@@ -35,29 +35,11 @@ jobs:
     steps:
       - uses: actions/checkout@v4
 
-      - name: Extract version from tag
-        id: version
-        run: |
-          if [ -n "${{ github.event.inputs.version }}" ]; then
-            echo "VERSION=${{ github.event.inputs.version }}" >> $GITHUB_OUTPUT
-          else
-            # Strip the 'v' prefix from the tag
-            echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_OUTPUT
-          fi
-
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.12"
 
-      - name: Update version in pyproject.toml
-        run: |
-          VERSION=${{ steps.version.outputs.VERSION }}
-          echo "Setting version to $VERSION"
-          sed -i "s/^version = .*/version = \"$VERSION\"/" pyproject.toml
-          echo "Updated pyproject.toml:"
-          grep "^version" pyproject.toml
-
       - name: Install build tools
         run: python -m pip install --upgrade build
 

.gitignore

@@ -47,6 +47,8 @@ sqlit-notifications/
 # Integration test artifacts
 tests/integration/python_packages/artifacts/
 
+sqlit/_version.py
+
 # Local assets (except logo for README)
 assets/*
 !assets/favorites/

pyproject.toml

@@ -1,10 +1,9 @@
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
 [project]
 name = "sqlit-tui"
-version = "0.5.1"
 description = "A terminal UI for SQL Server, PostgreSQL, MySQL, SQLite, Oracle, and more"
 readme = "README.md"
 license = "MIT"
@@ -33,6 +32,7 @@ dependencies = [
     "keyring>=24.0.0",
     "docker>=7.0.0",  # Docker container auto-detection (lazy loaded)
 ]
+dynamic = ["version"]
 
 [project.optional-dependencies]
 all = [
@@ -86,6 +86,12 @@ dev = [
     "pre-commit>=3.0",
 ]
 
+[tool.hatch.version]
+source = "vcs"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "sqlit/_version.py"
+
 [tool.ruff]
 target-version = "py310"
 line-length = 120

sqlit/__init__.py

@@ -12,34 +12,20 @@
     "ConnectionConfig",
 ]
 
+try:
+    from ._version import __version__
+except ImportError:
+    __version__ = "0.0.0.dev"
+
 if TYPE_CHECKING:
     from .app import SSMSTUI
     from .cli import main
     from .config import AuthType, ConnectionConfig
     from importlib.metadata import PackageNotFoundError  # noqa: F401
 
 
-_VERSION_CACHE: str | None = None
-
-
-def _get_version() -> str:
-    global _VERSION_CACHE
-    if _VERSION_CACHE is not None:
-        return _VERSION_CACHE
-    try:
-        from importlib.metadata import PackageNotFoundError, version
-
-        _VERSION_CACHE = version("sqlit-tui")
-    except PackageNotFoundError:
-        # Package not installed (development mode without editable install)
-        _VERSION_CACHE = "0.0.0.dev"
-    return _VERSION_CACHE
-
-
 def __getattr__(name: str) -> Any:
     """Lazy import for heavy modules to keep package import side-effect free."""
-    if name == "__version__":
-        return _get_version()
     if name == "main":
         from .cli import main