refactor(build): build project using PEP 621

nejch · JohnVillalovos · commit 71fca8c8f5c7 · 2023-10-11T14:45:58.000-07:00
BREAKING CHANGE: python-gitlab now stores metadata in pyproject.toml
as per PEP 621, with setup.py removed. pip version v21.1 or higher is
required if you want to perform an editable install.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -40,7 +40,6 @@ repos:
           - responses==0.23.1
           - types-PyYAML==6.0.12
           - types-requests==2.28.11.2
-          - types-setuptools==65.5.0.1
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0
     hooks:
diff --git a/Dockerfile b/Dockerfile
@@ -3,7 +3,7 @@ FROM python:3.11-${PYTHON_FLAVOR} AS build
 
 WORKDIR /opt/python-gitlab
 COPY . .
-RUN python setup.py bdist_wheel
+RUN pip install build && python -m build
 
 FROM python:3.11-${PYTHON_FLAVOR}
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,3 +1,63 @@
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "python-gitlab"
+description="A python wrapper for the GitLab API"
+readme = "README.rst"
+authors = [
+    {name = "Gauvain Pocentek", email= "gauvain@pocentek.net"}
+]
+maintainers = [
+    {name = "John Villalovos", email="john@sodarock.com"},
+    {name = "Max Wittig", email="max.wittig@siemens.com"},
+    {name = "Nejc Habjan", email="nejc.habjan@siemens.com"},
+    {name = "Roger Meier", email="r.meier@siemens.com"}
+]
+requires-python = ">=3.8.0"
+dependencies = [
+    "requests>=2.25.0",
+    "requests-toolbelt>=0.10.1",
+]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Console",
+    "Intended Audience :: System Administrators",
+    "License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)",
+    "Natural Language :: English",
+    "Operating System :: POSIX",
+    "Operating System :: Microsoft :: Windows",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11"
+]
+keywords = ["api", "client", "gitlab", "python", "python-gitlab", "wrapper"]
+license = {text = "LGPL-3.0-or-later"}
+dynamic = ["version"]
+
+[project.optional-dependencies]
+autocompletion = ["argcomplete>=1.10.0,<3"]
+yaml = ["PyYaml>=6.0.1"]
+
+[project.scripts]
+gitlab = "gitlab.cli:main"
+
+[project.urls]
+Homepage = "https://github.com/python-gitlab/python-gitlab"
+Changelog = "https://github.com/python-gitlab/python-gitlab/blob/main/CHANGELOG.md"
+Documentation = "https://python-gitlab.readthedocs.io"
+Source = "https://github.com/python-gitlab/python-gitlab"
+
+[tool.setuptools.packages.find]
+exclude = ["docs*", "tests*"]
+
+[tool.setuptools.dynamic]
+version = { attr = "gitlab._version.__version__" }
+
 [tool.isort]
 profile = "black"
 multi_line_output = 3
diff --git a/requirements-test.txt b/requirements-test.txt
@@ -7,5 +7,4 @@ pytest-github-actions-annotate-failures==0.2.0
 pytest==7.4.2
 PyYaml==6.0.1
 responses==0.23.3
-setuptools==68.2.2
 wheel==0.41.2
diff --git a/setup.py b/setup.py
diff --git a/tests/smoke/test_dists.py b/tests/smoke/test_dists.py
@@ -1,34 +1,40 @@
 import tarfile
 import zipfile
+import subprocess
+import sys
 from pathlib import Path
-from sys import version_info
+
 
 import pytest
-from setuptools import sandbox
 
 from gitlab._version import __title__, __version__
 
-DIST_DIR = Path("dist")
 DOCS_DIR = "docs"
 TEST_DIR = "tests"
 SDIST_FILE = f"{__title__}-{__version__}.tar.gz"
-WHEEL_FILE = (
-    f"{__title__.replace('-', '_')}-{__version__}-py{version_info.major}-none-any.whl"
-)
+WHEEL_FILE = f"{__title__.replace('-', '_')}-{__version__}-py{sys.version_info.major}-none-any.whl"
+
+
+@pytest.fixture(scope="session")
+def build(tmp_path_factory: Path):
+    temp_dir = tmp_path_factory.mktemp("build")
+    subprocess.run([sys.executable, "-m", "build", "--outdir", temp_dir], check=True)
+    return temp_dir
 
 
-@pytest.fixture(scope="function")
-def build() -> None:
-    sandbox.run_setup("setup.py", ["--quiet", "clean", "--all"])  # type: ignore[no-untyped-call]
-    sandbox.run_setup("setup.py", ["--quiet", "sdist", "bdist_wheel"])  # type: ignore[no-untyped-call]
+def test_sdist_includes_docs_and_tests(build: subprocess.CompletedProcess) -> None:
+    sdist = tarfile.open(build / SDIST_FILE, "r:gz")
+    sdist_dir = f"{__title__}-{__version__}"
 
+    docs_dir = sdist.getmember(f"{sdist_dir}/{DOCS_DIR}")
+    test_dir = sdist.getmember(f"{sdist_dir}/{TEST_DIR}")
+    readme = sdist.getmember(f"{sdist_dir}/README.rst")
 
-def test_sdist_includes_tests(build):
-    sdist = tarfile.open(DIST_DIR / SDIST_FILE, "r:gz")
-    test_dir = sdist.getmember(f"{__title__}-{__version__}/{TEST_DIR}")
+    assert docs_dir.isdir()
     assert test_dir.isdir()
+    assert readme.isfile()
 
 
-def test_wheel_excludes_docs_and_tests(build):
-    wheel = zipfile.ZipFile(DIST_DIR / WHEEL_FILE)
+def test_wheel_excludes_docs_and_tests(build: subprocess.CompletedProcess) -> None:
+    wheel = zipfile.ZipFile(build / WHEEL_FILE)
     assert not any(file.startswith((DOCS_DIR, TEST_DIR)) for file in wheel.namelist())
diff --git a/tox.ini b/tox.ini
@@ -65,9 +65,10 @@ commands =
 [testenv:twine-check]
 basepython = python3
 deps = -r{toxinidir}/requirements.txt
+       build
        twine
 commands =
-  python3 setup.py sdist bdist_wheel
+  python -m build
   twine check dist/*
 
 [testenv:venv]
