-
Notifications
You must be signed in to change notification settings - Fork 14
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
1 parent
3f0ff01
commit 5b3133f
Showing
4 changed files
with
81 additions
and
51 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
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, "tutornotes", "__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 @jfavellar90) |
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,60 @@ | ||
# https://packaging.python.org/en/latest/tutorials/packaging-projects/ | ||
# https://hatch.pypa.io/latest/config/build/ | ||
|
||
[project] | ||
name = "tutor-notes" | ||
description = "A Tutor plugin for student notes" | ||
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] | ||
Documentation = "https://github.com/overhangio/tutor-notes#readme" | ||
Issues = "https://github.com/overhangio/tutor-notes/issues" | ||
Source = "https://github.com/overhangio/tutor-notes" | ||
|
||
[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 = ["tutornotes"] | ||
|
||
[tool.hatch.build.targets.sdist] | ||
# Disable strict naming, otherwise twine is not able to detect name/version | ||
strict-naming = false | ||
include = [ "/tutornotes"] | ||
exclude = ["tests*"] | ||
|
||
[project.entry-points."tutor.plugin.v1"] | ||
notes = "tutornotes.plugin" |