fix and modernize packaging (#211)

Author: 1fanwang

.github/workflows/publish-to-test-pypi.yml

@@ -10,15 +10,18 @@ jobs:
     runs-on: ubuntu-22.04
     steps:
     - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
     - name: Set up Python 3.x
       uses: actions/setup-python@v5
       with:
         python-version: '3.x'
-    - name: Install pypa/build
+    - name: Install dependencies
       run: >-
         python -m
         pip install
         build
+        setuptools_scm
         --user
     - name: Build a binary wheel and a source tarball
       run: >-

README.md

@@ -38,6 +38,42 @@ my_uuid = uuid.UUID(hex="C232AB00-9414-11EC-B3C8-9E6BDECED846")
 assert uuid6.uuid1_to_uuid6(my_uuid) == uuid.UUID(hex="1EC9414C-232A-6B00-B3C8-9E6BDECED846")
 ```
 
+# Versioning
+
+> **Important Notice:** Starting with version `2025.0.0`, this project will transition from Calendar Versioning (YYYY.MM.DD) to Semantic Versioning (MAJOR.MINOR.PATCH).
+
+### Version Scheme
+
+- **Before 2025.0.0**: Calendar Versioning (e.g., `2024.07.10`)
+- **2025.0.0 and after**: Semantic Versioning where:
+  - **MAJOR**: Breaking changes
+  - **MINOR**: New features (backward compatible)
+  - **PATCH**: Bug fixes (backward compatible)
+
+### For Dependency Management
+
+- Requirements like `>=2024.07.10` will continue to work with newer versions
+- For the latest features, specify `>=2025.0.0`
+
+### Release Process
+
+Version numbers are managed automatically via Git tags.
+
+1. Maintainers create a new tag following the version scheme:
+   ```bash
+   git tag <version>
+   git tag 2025.0.0   # First SemVer release
+   git tag 2025.1.0   # Feature release
+   git tag 2025.0.1   # Bug fix release
+   ```
+
+2. Push the tag to GitHub
+   ```bash
+   git push origin <version>
+   ```
+
+3. GitHub Actions will build and publish the package to PyPI
+
 ## Which UUID version should I use?
 
 > Implementations SHOULD utilize UUID version 7 over UUID version 1 and 6 if possible.

pyproject.toml

@@ -1,9 +1,58 @@
 [build-system]
-requires = ["setuptools", "wheel"]
+requires = ["setuptools>=45", "setuptools_scm[toml]>=6.2", "wheel"]
+build-backend = "setuptools.build_meta"
 
 [tool.coverage.run]
 branch = true
 source = ["src/"]
 
 [tool.mypy]
 files = ["*.py", "test/", "src/"]
+
+[project]
+name = "uuid6"
+dynamic = ["version"]
+description = "New time-based UUID formats which are suited for use as a database key"
+readme = "README.md"
+authors = [
+    {name = "Oittaa"}
+]
+requires-python = ">=3.9"
+license = {text = "MIT"}
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+]
+keywords = [
+    "uuid",
+    "uuid6",
+    "uuid7",
+    "uuid8",
+    "uuidv6",
+    "uuidv7",
+    "uuidv8",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/oittaa/uuid6-python"
+"Bug Tracker" = "https://github.com/oittaa/uuid6-python/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"*" = ["py.typed"]
+
+[tool.setuptools_scm]

setup.py

@@ -4,6 +4,13 @@
 generating version 6, 7, and 8 UUIDs as specified in RFC 9562.
 """
 
+# Get version
+try:
+    from ._version import version as __version__
+except ImportError:
+    __version__ = "0.0.0.dev0"
+
+
 import secrets
 import time
 import uuid