feat: migrate from setup.py/setuptools to pyproject.toml/hatch

.github/workflows/test.yml

@@ -18,8 +18,6 @@ jobs:
         uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Upgrade pip
-        run: python -m pip install --upgrade pip setuptools
       - name: Install dependencies
         run: |
           pip install .[dev]

.hatch_build.py

@@ -0,0 +1,22 @@
+# https://hatch.pypa.io/latest/how-to/config/dynamic-metadata/
+import os
+import typing as t
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+
+HERE = os.path.dirname(__file__)
+
+
+class MetaDataHook(MetadataHookInterface):
+    def update(self, metadata: dict[str, t.Any]) -> None:
+        about = load_about()
+        metadata["version"] = about["__version__"]
+
+
+def load_about() -> dict[str, str]:
+    about: dict[str, str] = {}
+    with open(
+        os.path.join(HERE, "tutorcairn", "__about__.py"), "rt", encoding="utf-8"
+    ) as f:
+        exec(f.read(), about)  # pylint: disable=exec-used
+    return about

changelog.d/20250204_192514_danyal.faheem_migrate_to_pyproject.md

@@ -0,0 +1,2 @@
+- [Improvement] Migrate packaging from setup.py/setuptools to pyproject.toml/hatch. (by @Danyal-Faheem)
+  - For more details view tutor core PR: https://github.com/overhangio/tutor/pull/1163

pyproject.toml

@@ -1,2 +1,67 @@
+# https://packaging.python.org/en/latest/tutorials/packaging-projects/
+# https://hatch.pypa.io/latest/config/build/
+
+[project]
+name = "tutor-cairn"
+license = { text = "AGPL-3.0-only" }
+authors = [
+  {name = "Edly"}, {email = "[email protected]"},
+]
+maintainers = [
+  {name = "Danyal Faheem"}, {email = "[email protected]"}
+]
+description = "Scalable, real-time analytics for Open edX"
+readme = {file = "README.rst", content-type = "text/x-rst"}
+requires-python = ">= 3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+  "tutor>=19.0.0,<20.0.0",
+]
+# these fields will be set by hatch_build.py
+dynamic = ["version"]
+
+[project.optional-dependencies]
+dev = [
+  "tutor[dev]>=19.0.0,<20.0.0", 
+  "pylint", 
+  "black"
+]
+
+[project.entry-points."tutor.plugin.v1"]
+cairn = "tutorcairn.plugin"
+
+# https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels
+[project.urls]
+Homepage = "https://docs.tutor.edly.io/"
+Documentation = "https://docs.tutor.edly.io/"
+Code = "https://github.com/overhangio/tutor-cairn"
+Issues = "https://github.com/overhangio/tutor-cairn.git/issues"
+Changelog = "https://github.com/overhangio/tutor-cairn/blob/release/CHANGELOG.md"
+Community = "https://discuss.openedx.org/tag/tutor"
+
+# hatch-specific configuration
+[tool.hatch.metadata.hooks.custom]
+path = ".hatch_build.py"
+
 [build-system]
-requires = ["setuptools", "wheel"]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+# Disable strict naming, otherwise twine is not able to detect name/version
+strict-naming = false
+include = [ "/tutorcairn"]
+exclude = ["tests*"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["tutorcairn"]