feat: migrate from setup.py to pyproject.toml (#130)

Co-authored-by: Ahmed Khalid <[email protected]>

Author: ahmed-arb

.github/workflows/test.yml

@@ -15,8 +15,6 @@ jobs:
         uses: actions/setup-python@v2
         with:
           python-version: 3.9
-      - name: Upgrade pip
-        run: python -m pip install --upgrade pip setuptools
       - name: Install dependencies
         run: |
           pip install .[dev]

.hatch_build.py

@@ -0,0 +1,20 @@
+# 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.abspath(os.path.dirname(__file__))
+
+
+class JSONMetaDataHook(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, "tutorindigo", "__about__.py"), "rt", encoding="utf-8") as f:
+        exec(f.read(), about)  # pylint: disable=exec-used
+    return about

MANIFEST.in

@@ -0,0 +1 @@
+- [Improvement] Migrate from `setup.py` (setuptools) to `pyproject.toml` (hatch). (by @ahmed-arb)

changelog.d/20250219_150716_ahmed.khalid_pyproject_toml.md

@@ -1,2 +1,58 @@
+#https://hatch.pypa.io/latest/config/build/
+
+[project]
+name = "tutor-indigo"
+description = "Indigo theme plugin for Tutor"
+readme = { file = "README.rst", content-type = "text/x-rst" }
+license = { text = "AGPLv3" }
+requires-python = ">=3.9"
+authors = [{ name = "Edly" }, { email = "[email protected]" }]
+maintainers = [{ name = "Edly" }, { email = "[email protected]" }]
+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-mfe>=19.0.0,<20.0.0", "tutor>=19.0.0,<20.0.0"]
+
+# hatch_build.py will set it later
+dynamic = ["version"]
+
+[project.optional-dependencies]
+dev = ["tutor[dev]>=19.0.0,<20.0.0"]
+
+[project.entry-points."tutor.plugin.v1"]
+indigo = "tutorindigo.plugin"
+
+[project.urls]
+Code = "https://github.com/overhangio/tutor-indigo"
+Community = "https://discuss.openedx.org"
+Documentation = "https://docs.tutor.edly.io/"
+Homepage = "https://github.com/overhangio/tutor-indigo"
+Changelog = "https://github.com/overhangio/tutor-indigo/blob/release/CHANGELOG.md"
+Issues = "https://github.com/overhangio/tutor-indigo/issues"
+
+# hatch related configurations
 [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 = ["/tutorindigo"]
+exclude = ["tests*"]
+
+# we need this becuase our project escapes default hatch file selection.
+# see https://hatch.pypa.io/latest/plugins/builder/wheel/#default-file-selection
+[tool.hatch.build.targets.wheel]
+packages = ["/tutorindigo"]
+
+[tool.hatch.metadata.hooks.custom]
+path = ".hatch_build.py"