-
Notifications
You must be signed in to change notification settings - Fork 339
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: migrate from setup.py to pyproject.toml
- Loading branch information
Ahmed Khalid
committed
Feb 19, 2025
1 parent
a1ae597
commit 51248bf
Showing
5 changed files
with
73 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
- [Improvement] Migrate from `setup.py` (setuptools) to `pyproject.toml` (hatch). (by @ahmed-arb) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,52 @@ | ||
#https://hatch.pypa.io/latest/config/build/ | ||
|
||
[project] | ||
name = "tutor-indigo" | ||
dynamic = ["version"] # hatch_build.py will set it later | ||
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 = "hello@edly.io" }] | ||
maintainers = [{ name = "Edly", email = "hina.khadim@arbisoft.com" }] | ||
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"] | ||
|
||
[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" | ||
"Issue tracker" = "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] | ||
include = ["/tutorindigo"] | ||
|
||
# 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" |