From 9ac90dfc6acab1719684a1221b30741fe438c09c Mon Sep 17 00:00:00 2001 From: jfavellar90 Date: Thu, 13 Feb 2025 20:29:19 -0500 Subject: [PATCH] feat: migrate from setup.py to pyproject.toml --- .hatch_build.py | 21 +++++++ ...0213_202807_jhony.avella_pyproject_toml.md | 1 + pyproject.toml | 63 ++++++++++++++++++- setup.py | 52 --------------- 4 files changed, 84 insertions(+), 53 deletions(-) create mode 100644 .hatch_build.py create mode 100644 changelog.d/20250213_202807_jhony.avella_pyproject_toml.md delete mode 100644 setup.py diff --git a/.hatch_build.py b/.hatch_build.py new file mode 100644 index 0000000..f7c58cf --- /dev/null +++ b/.hatch_build.py @@ -0,0 +1,21 @@ +# 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, "tutorxqueue", "__about__.py"), "rt", encoding="utf-8") as f: + exec(f.read(), about) # pylint: disable=exec-used + return about diff --git a/changelog.d/20250213_202807_jhony.avella_pyproject_toml.md b/changelog.d/20250213_202807_jhony.avella_pyproject_toml.md new file mode 100644 index 0000000..567ead3 --- /dev/null +++ b/changelog.d/20250213_202807_jhony.avella_pyproject_toml.md @@ -0,0 +1 @@ +- [Improvement] Migrate from `setup.py` (setuptools) to `pyproject.toml` (hatch). (by @jfavellar90) diff --git a/pyproject.toml b/pyproject.toml index d1e6ae6..3f3f8f2 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,2 +1,63 @@ +# https://packaging.python.org/en/latest/tutorials/packaging-projects/ +# https://hatch.pypa.io/latest/config/build/ + +[project] +name = "tutor-xqueue" +description = "A Tutor plugin for Xqueue (external grading system)" +authors = [ + { name = "Edly" }, + { email = "hello@edly.io"}, +] +maintainers = [ + { name = "eduNEXT" }, + { email = "contact@edunext.co" }, +] +license = {file = "LICENSE.txt"} +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", +] +optional-dependencies = { dev = ["tutor[dev]>=19.0.0,<20.0.0"] } + +# These fields will be set by hatch_build.py +dynamic = ["version"] + +# https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels +[project.urls] +Homepage = "https://docs.tutor.edly.io/" +Documentation = "https://github.com/overhangio/tutor-xqueue#readme" +Issues = "https://github.com/overhangio/tutor-xqueue/issues" +Source = "https://github.com/overhangio/tutor-xqueue" +Changelog = "https://github.com/overhangio/tutor-xqueue/blob/release/CHANGELOG.md" +Community = "https://discuss.openedx.org/tag/tutor" + [build-system] -requires = ["setuptools", "wheel"] +requires = ["hatchling"] +build-backend = "hatchling.build" + +# hatch-specific configuration +[tool.hatch.metadata.hooks.custom] +path = ".hatch_build.py" + +[tool.hatch.build.targets.wheel] +packages = ["tutorxqueue"] + +[tool.hatch.build.targets.sdist] +# Disable strict naming, otherwise twine is not able to detect name/version +strict-naming = false +include = [ "/tutorxqueue"] + +[project.entry-points."tutor.plugin.v1"] +xqueue = "tutorxqueue.plugin" diff --git a/setup.py b/setup.py deleted file mode 100644 index bc01c06..0000000 --- a/setup.py +++ /dev/null @@ -1,52 +0,0 @@ -import io -import os -from setuptools import setup, find_packages - -here = os.path.abspath(os.path.dirname(__file__)) - -with io.open(os.path.join(here, "README.rst"), "rt", encoding="utf8") as f: - readme = f.read() - -about = {} -with io.open( - os.path.join(here, "tutorxqueue", "__about__.py"), "rt", encoding="utf-8" -) as f: - exec(f.read(), about) - -setup( - name="tutor-xqueue", - version=about["__version__"], - url="https://docs.tutor.edly.io/", - project_urls={ - "Documentation": "https://docs.tutor.edly.io/", - "Code": "https://github.com/overhangio/tutor-xqueue", - "Issue tracker": "https://github.com/overhangio/tutor-xqueue/issues", - "Community": "https://discuss.openedx.org", - }, - license="AGPLv3", - author="Edly", - author_email="hello@edly.io", - maintainer="eduNEXT", - description="A Tutor plugin for Xqueue (external grading system)", - long_description=readme, - long_description_content_type="text/x-rst", - packages=find_packages(exclude=["tests*"]), - include_package_data=True, - python_requires=">=3.9", - install_requires=["tutor>=19.0.0,<20.0.0", "requests"], - extras_require={ - "dev": ["tutor[dev]>=19.0.0,<20.0.0"], - }, - entry_points={"tutor.plugin.v1": ["xqueue = tutorxqueue.plugin"]}, - 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", - ], -)