diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 5e42086..00bb3d6 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -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] diff --git a/.hatch_build.py b/.hatch_build.py new file mode 100644 index 0000000..43439d6 --- /dev/null +++ b/.hatch_build.py @@ -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, "tutorminio", "__about__.py"), "rt", encoding="utf-8" + ) as f: + exec(f.read(), about) # pylint: disable=exec-used + return about diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index 8346a09..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include tutorminio/patches * -recursive-include tutorminio/templates * \ No newline at end of file diff --git a/changelog.d/20250206_125229_danyal.faheem_migrate_to_pyproject.md b/changelog.d/20250206_125229_danyal.faheem_migrate_to_pyproject.md new file mode 100644 index 0000000..320f611 --- /dev/null +++ b/changelog.d/20250206_125229_danyal.faheem_migrate_to_pyproject.md @@ -0,0 +1,2 @@ +- [Improvement] Migrate packaging from setup.py/setuptools to pyproject.toml/hatch. (by @Danyal-Faheem) + - For more details view tutor core PR: https://github.com/overhangio/tutor/pull/1163 \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index d1e6ae6..cf8a44a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,2 +1,67 @@ +# https://packaging.python.org/en/latest/tutorials/packaging-projects/ +# https://hatch.pypa.io/latest/config/build/ + +[project] +name = "tutor-minio" +license = { text = "AGPL-3.0-only" } +requires-python = ">= 3.9" +authors = [ + {name = "Edly"}, {email = "hello@edly.io"}, +] +maintainers = [ + {name = "Danyal Faheem"}, {email = "danyal.faheem@arbisoft.com"} +] +description = "A Tutor plugin for object storage in MinIO" +readme = {file = "README.rst", content-type = "text/x-rst"} +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" +] + +[project.entry-points."tutor.plugin.v1"] +minio = "tutorminio.plugin" + +# 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/" +Code = "https://github.com/overhangio/tutor-minio" +Issues = "https://github.com/overhangio/tutor-minio.git/issues" +Changelog = "https://github.com/overhangio/tutor-minio/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 = [ "/tutorminio"] +exclude = ["tests*"] + +[tool.hatch.build.targets.wheel] +packages = ["tutorminio"] diff --git a/setup.py b/setup.py deleted file mode 100644 index 5381166..0000000 --- a/setup.py +++ /dev/null @@ -1,51 +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, "tutorminio", "__about__.py"), "rt", encoding="utf-8" -) as f: - exec(f.read(), about) - -setup( - name="tutor-minio", - version=about["__version__"], - url="https://docs.tutor.edly.io/", - project_urls={ - "Documentation": "https://docs.tutor.edly.io/", - "Code": "https://github.com/overhangio/tutor-minio", - "Issue tracker": "https://github.com/overhangio/tutor-minio/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 object storage in MinIO", - 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"], - extras_require={"dev": "tutor[dev]>=19.0.0,<20.0.0"}, - entry_points={"tutor.plugin.v1": ["minio = tutorminio.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", - ], -)