Skip to content

Commit

Permalink
feat: migrate from setup.py to pyproject.toml
Browse files Browse the repository at this point in the history
  • Loading branch information
jfavellar90 committed Feb 14, 2025
1 parent 02a4b1e commit 9ac90df
Show file tree
Hide file tree
Showing 4 changed files with 84 additions and 53 deletions.
21 changes: 21 additions & 0 deletions .hatch_build.py
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions changelog.d/20250213_202807_jhony.avella_pyproject_toml.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
- [Improvement] Migrate from `setup.py` (setuptools) to `pyproject.toml` (hatch). (by @jfavellar90)
63 changes: 62 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -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"
52 changes: 0 additions & 52 deletions setup.py

This file was deleted.

0 comments on commit 9ac90df

Please sign in to comment.