hatchling versioning; ci updates

Author: johnnygreco

.github/workflows/ci.yml

@@ -15,7 +15,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, macos-latest]
-        python-version: ["3.10", "3.11", "3.12", "3.13"]
+        python-version: ["3.11", "3.12", "3.13"]
 
     steps:
       - name: Checkout code

.gitignore

@@ -79,6 +79,9 @@ venv.bak/
 *.tar.gz
 *.zip
 
+# Auto-generated version file
+src/data_designer/_version.py
+
 # Local scratch space
 .scratch/
 

VERSIONING.md

@@ -0,0 +1,90 @@
+# Versioning Guide
+
+DataDesigner uses **semantic versioning** with automated version management via `hatch-vcs`.
+
+## How It Works
+
+Versions are automatically derived from git tags:
+
+- **No tag**: `0.1.0.dev<N>+g<commit-hash>` (development version)
+- **Tagged commit**: `1.2.3` (release version)
+- **After tag**: `1.2.4.dev<N>+g<commit-hash>` (next development version)
+
+## Version Format
+
+```
+MAJOR.MINOR.PATCH
+```
+
+- **MAJOR**: Breaking changes (incompatible API changes)
+- **MINOR**: New features (backward-compatible)
+- **PATCH**: Bug fixes (backward-compatible)
+
+## Creating a Release
+
+When ready to release version `X.Y.Z`:
+
+```bash
+# Tag the release
+git tag vX.Y.Z
+
+# Push the tag
+git push origin vX.Y.Z
+
+# Build and publish
+uv build
+uv publish
+```
+
+Example:
+```bash
+git tag v0.1.0
+git push origin v0.1.0
+```
+
+## Accessing Version in Code
+
+Users can access the version:
+
+```python
+import data_designer
+
+print(data_designer.__version__)
+# Output: 0.1.0 (or 0.1.0.dev18+ga7496d01a if between releases)
+```
+
+## Technical Details
+
+- Version source: Git tags via `hatch-vcs`
+- Version file: `src/data_designer/_version.py` (auto-generated, not tracked in git)
+- Fallback strategy:
+  1. Try to import from `_version.py` (generated during build)
+  2. Fall back to `importlib.metadata.version()` (works for editable installs)
+  3. Final fallback: `0.0.0.dev0+unknown` (if package not installed)
+- Configuration: [pyproject.toml](pyproject.toml)
+
+## For Collaborators
+
+When you clone the repository and run `uv sync`, you won't have `_version.py` in your local directory. This is expected! The version system has a fallback:
+
+```bash
+git clone <repo>
+uv sync
+uv run python -c "from data_designer import __version__; print(__version__)"
+# Works! Uses importlib.metadata fallback
+```
+
+The `_version.py` file is auto-generated during:
+- Editable installs (`uv pip install -e .`)
+- Package builds (`uv build`)
+- CI/CD builds
+
+You don't need to commit or manually create this file.
+
+## Development Workflow
+
+1. **During development**: Commit normally, version auto-increments as dev versions
+2. **Ready to release**: Create and push a git tag (e.g., `v0.1.0`)
+3. **After release**: Continue development, version becomes next dev version (e.g., `0.1.1.dev1`)
+
+No manual version bumping required!

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "data-designer"
-version = "0.0.1"
+dynamic = ["version"]
 description = "General framework for synthetic data generation"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -63,9 +63,16 @@ dev = [
 ]
 
 [build-system]
-requires = ["hatchling"]
+requires = ["hatchling", "hatch-vcs"]
 build-backend = "hatchling.build"
 
+[tool.hatch.version]
+source = "vcs"
+fallback-version = "0.1.0.dev0"
+
+[tool.hatch.build.hooks.vcs]
+version-file = "src/data_designer/_version.py"
+
 [tool.pytest.ini_options]
 testpaths = ["tests"]
 asyncio_default_fixture_loop_scope = "session"

src/data_designer/__init__.py

@@ -1,2 +1,15 @@
 # SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 # SPDX-License-Identifier: Apache-2.0
+
+try:
+    from data_designer._version import __version__
+except ImportError:
+    # Fallback for editable installs without build
+    try:
+        from importlib.metadata import version
+
+        __version__ = version("data-designer")
+    except Exception:
+        __version__ = "0.0.0.dev0+unknown"
+
+__all__ = ["__version__"]