feat: migrate from setup.py/setuptools to pyproject.toml/hatch (#99)
* feat: migrate to pyproject.toml and hatch * migrate from setup.py/setuptools to pyproject.toml/hatch. * add optional dependencies * fix license and author * update maintainer name --------- Co-authored-by: Muhammad Faraz Maqsood <faraz.maqsood@192.168.10.35> Co-authored-by: Muhammad Labeeb <mlabeeb03@gmail.com>
This commit is contained in:
Muhammad Faraz Maqsood
GitHub
parent
4386c85adf
commit
5c4daa9318
2
.github/workflows/test.yml
vendored
2
.github/workflows/test.yml
vendored
@ -18,8 +18,6 @@ jobs:
|
||||
uses: actions/setup-python@v5
|
||||
with:
|
||||
python-version: ${{ matrix.python-version }}
|
||||
- name: Upgrade pip
|
||||
run: python -m pip install --upgrade pip setuptools
|
||||
- name: Install dependencies
|
||||
run: |
|
||||
pip install .[dev]
|
||||
|
||||
22
.hatch_build.py
Normal file
22
.hatch_build.py
Normal file
@ -0,0 +1,22 @@
|
||||
# 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, "tutordiscovery", "__about__.py"), "rt", encoding="utf-8"
|
||||
) as f:
|
||||
exec(f.read(), about) # pylint: disable=exec-used
|
||||
return about
|
||||
@ -1,2 +0,0 @@
|
||||
recursive-include tutordiscovery/patches *
|
||||
recursive-include tutordiscovery/templates *
|
||||
@ -234,7 +234,7 @@ Although tutor-discovery does not start event bus consumption by default, it sup
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
This Tutor plugin is maintained by Muhammad Faraz Maqsood from `Edly`_.
|
||||
This Tutor plugin is maintained by Muhammad Labeeb from `Edly`_.
|
||||
Community support is available from the official `Open edX forum`_.
|
||||
Do you need help with this plugin? See the `troubleshooting`_
|
||||
section from the Tutor documentation.
|
||||
|
||||
@ -0,0 +1,2 @@
|
||||
- [Improvement] Migrate packaging from setup.py/setuptools to pyproject.toml/hatch. (by @Faraz32123)
|
||||
- For more details view tutor core PR: https://github.com/overhangio/tutor/pull/1163
|
||||
@ -1,2 +1,69 @@
|
||||
# https://packaging.python.org/en/latest/tutorials/packaging-projects/
|
||||
# https://hatch.pypa.io/latest/config/build/
|
||||
|
||||
[project]
|
||||
name = "tutor-discovery"
|
||||
license = { text = "AGPL-3.0-only" }
|
||||
authors = [
|
||||
{name = "Edly"},
|
||||
{email = "hello@edly.io"},
|
||||
]
|
||||
maintainers = [
|
||||
{name = "Muhammad Labeeb"},
|
||||
{email = "muhammad.labeeb@arbisoft.com"},
|
||||
]
|
||||
description="A Tutor plugin for course discovery, the Open edX service for providing access to consolidated course and program metadata"
|
||||
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",
|
||||
]
|
||||
# these fields will be set by hatch_build.py
|
||||
dynamic = ["version"]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dev = [
|
||||
"tutor[dev]>=19.0.0,<20.0.0",
|
||||
"pylint",
|
||||
"black"
|
||||
]
|
||||
|
||||
# https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels
|
||||
[project.urls]
|
||||
Homepage = "https://docs.tutor.edly.io/"
|
||||
Documentation = "https://docs.tutor.edly.io/"
|
||||
Source = "https://github.com/overhangio/tutor-discovery"
|
||||
Issues = "https://github.com/overhangio/tutor-discovery/issues"
|
||||
Changelog = "https://github.com/overhangio/tutor-discovery/blob/release/CHANGELOG.md"
|
||||
Community = "https://discuss.openedx.org/tag/tutor"
|
||||
|
||||
# hatch-specific configuration
|
||||
[tool.hatch.metadata.hooks.custom]
|
||||
path = ".hatch_build.py"
|
||||
|
||||
[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 = [ "/tutordiscovery"]
|
||||
exclude = ["tests*"]
|
||||
|
||||
[tool.hatch.build.targets.wheel]
|
||||
packages = ["tutordiscovery"]
|
||||
|
||||
[project.entry-points."tutor.plugin.v1"]
|
||||
discovery = "tutordiscovery.plugin"
|
||||
|
||||
52
setup.py
52
setup.py
@ -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, "tutordiscovery", "__about__.py"), "rt", encoding="utf-8"
|
||||
) as f:
|
||||
exec(f.read(), about)
|
||||
|
||||
|
||||
setup(
|
||||
name="tutor-discovery",
|
||||
version=about["__version__"],
|
||||
url="https://docs.tutor.edly.io/",
|
||||
project_urls={
|
||||
"Documentation": "https://docs.tutor.edly.io/",
|
||||
"Code": "https://github.com/overhangio/tutor-discovery",
|
||||
"Issue tracker": "https://github.com/overhangio/tutor-discovery/issues",
|
||||
"Community": "https://discuss.openedx.org",
|
||||
},
|
||||
license="AGPLv3",
|
||||
author="Edly",
|
||||
author_email="hello@edly.io",
|
||||
maintainer="Edly",
|
||||
maintainer_email="faraz.maqsood@arbisoft.com",
|
||||
description="A Tutor plugin for course discovery, the Open edX service for providing access to consolidated course and program metadata",
|
||||
long_description=readme,
|
||||
long_description_content_type="text/x-rst",
|
||||
packages=find_packages(exclude=["tests*"]),
|
||||
include_package_data=True,
|
||||
install_requires=["tutor>=19.0.0,<20.0.0"],
|
||||
extras_require={"dev": "tutor[dev]>=19.0.0,<20.0.0"},
|
||||
python_requires=">=3.9",
|
||||
entry_points={"tutor.plugin.v1": ["discovery = tutordiscovery.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",
|
||||
],
|
||||
)
|
||||
Loading…
x
Reference in New Issue
Block a user
