diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 1c8501f..d7e40a8 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..ed60b7f --- /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, "tutorandroid", "__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 a5ea76c..0000000 --- a/MANIFEST.in +++ /dev/null @@ -1,2 +0,0 @@ -recursive-include tutorandroid/patches * -recursive-include tutorandroid/templates * diff --git a/changelog.d/20250224_082522_abdul.muqadim_migrate_to_pyproject.md b/changelog.d/20250224_082522_abdul.muqadim_migrate_to_pyproject.md new file mode 100644 index 0000000..3b78764 --- /dev/null +++ b/changelog.d/20250224_082522_abdul.muqadim_migrate_to_pyproject.md @@ -0,0 +1,3 @@ + +- [Improvement] Migrate packaging from setup.py/setuptools to pyproject.toml/hatch. (by @Abdul-Muqadim-Arbisoft) + - 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..1502ff5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,2 +1,68 @@ +# https://packaging.python.org/en/latest/tutorials/packaging-projects/ +# https://hatch.pypa.io/latest/config/build/ + +[project] +name = "tutor-android" +license = { text = "AGPL-3.0-only" } +authors = [ + { name = "Edly" }, + { email = "hello@edly.io" } +] +maintainers = [ + { name = "Abdul-Muqadim" }, + { email = "abdul.muqadim@arbisoft.com" } +] +description = "Android mobile app plugin for Tutor" +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" +] +# Version will be dynamically loaded from __about__.py +dynamic = ["version"] + +[project.optional-dependencies] +dev = [ + "tutor[dev]>=19.0.0,<20.0.0", + "pylint", + "black" +] + +[project.entry-points."tutor.plugin.v1"] +android = "tutorandroid.plugin" + +# URLs for documentation and issue tracking +[project.urls] +Homepage = "https://github.com/overhangio/tutor-android" +Documentation = "https://github.com/overhangio/tutor-android" +Code = "https://github.com/overhangio/tutor-android" +Issues = "https://github.com/overhangio/tutor-android/issues" +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 for twine compatibility +strict-naming = false +include = [ "/tutorandroid" ] +exclude = [ "tests*" ] + +[tool.hatch.build.targets.wheel] +packages = ["tutorandroid"] diff --git a/setup.py b/setup.py deleted file mode 100644 index 95284cc..0000000 --- a/setup.py +++ /dev/null @@ -1,65 +0,0 @@ -import io -import os -from setuptools import setup, find_packages - -HERE = os.path.abspath(os.path.dirname(__file__)) - - -def load_readme(): - with io.open(os.path.join(HERE, "README.rst"), "rt", encoding="utf8") as f: - return f.read() - - -def load_about(): - about = {} - with io.open( - os.path.join(HERE, "tutorandroid", "__about__.py"), - "rt", - encoding="utf-8", - ) as f: - exec(f.read(), about) # pylint: disable=exec-used - return about - - -ABOUT = load_about() - - -setup( - name="tutor-android", - version=ABOUT["__version__"], - url="https://github.com/overhangio/tutor-android", - project_urls={ - "Code": "https://github.com/overhangio/tutor-android", - "Issue tracker": "https://github.com/overhangio/tutor-android/issues", - "Community": "https://discuss.openedx.org", - }, - license="AGPLv3", - author="Edly", - author_email="hello@edly.io", - maintainer="Edly", - maintainer_email="abdul.muqadim@arbisoft.com", - description="Android mobile app plugin for Tutor", - long_description=load_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": [ - "android = tutorandroid.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", - ], -)