Reimplementing python packaging replacing setup.py with pyproject.toml

globaleaks · Feb 3, 2025 · ff5c3ea · ff5c3ea
1 parent df4c725
commit ff5c3ea
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 41 deletions.
diff --git a/.github/workflows/scripts/build_and_install.sh b/.github/workflows/scripts/build_and_install.sh
@@ -8,7 +8,7 @@ cd /build/globaleaks-whistleblowing-software
 
 sudo apt-get -y update
 
-sudo apt-get -y install brotli curl git debhelper devscripts dh-apparmor dh-python python3-all python3-pip python3-setuptools python3-sphinx
+sudo apt-get -y install brotli curl git debhelper devscripts dh-apparmor dh-python python3-all python3-pybuild python3-pip python3-setuptools python3-sphinx
 
 curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
 sudo apt-get update

diff --git a/.github/workflows/scripts/run_tests_backend.sh b/.github/workflows/scripts/run_tests_backend.sh
@@ -24,7 +24,7 @@ setupClient
 
 # Running backend tests
 echo "Running backend tests"
-cd $GITHUB_WORKSPACE/backend && coverage run setup.py test
+cd $GITHUB_WORKSPACE/backend && coverage run -m twisted.trial globaleaks.tests
 if [ $? -ne 0 ]; then
   backend_test_failed=1
 fi

diff --git a/backend/pyproject.toml b/backend/pyproject.toml
@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "globaleaks"
+dynamic = ["version"]
+description = "An open-source whistleblowing platform"
+readme = "README.md"
+requires-python = ">=3.8"
+authors = [
+    { name = "GlobaLeaks", email = "[email protected]" }
+]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
+    "Operating System :: OS Independent",
+]
+
+# Metadata dynamically loaded from the globaleaks package
+[tool.setuptools.dynamic]
+version = { attr = "globaleaks.__version__" }
+dependencies = {file = ["requirements.txt"]}
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["globaleaks*"]
+
+# Ensure non-Python files (e.g., templates, config files) are included
+[tool.setuptools.package-data]
+globaleaks = ["**/*"]
diff --git a/backend/setup.py b/backend/setup.py
diff --git a/debian/controlX/control.bionic b/debian/controlX/control.bionic
@@ -7,6 +7,7 @@ Build-Depends:
   devscripts,
   dh-apparmor,
   dh-python,
+  pybuild-plugin-pyproject,
   python3-all,
   python3-setuptools,
   python3-sphinx

diff --git a/debian/controlX/control.bookworm b/debian/controlX/control.bookworm
@@ -7,6 +7,7 @@ Build-Depends:
   devscripts,
   dh-apparmor,
   dh-python,
+  pybuild-plugin-pyproject,
   python3-all,
   python3-setuptools,
   python3-sphinx

diff --git a/debian/controlX/control.bullseye b/debian/controlX/control.bullseye
@@ -7,6 +7,7 @@ Build-Depends:
   devscripts,
   dh-apparmor,
   dh-python,
+  pybuild-plugin-pyproject,
   python3-all,
   python3-setuptools,
   python3-sphinx

diff --git a/debian/controlX/control.buster b/debian/controlX/control.buster
@@ -7,6 +7,7 @@ Build-Depends:
   devscripts,
   dh-apparmor,
   dh-python,
+  pybuild-plugin-pyproject,
   python3-all,
   python3-setuptools,
   python3-sphinx

diff --git a/debian/controlX/control.focal b/debian/controlX/control.focal
@@ -7,6 +7,7 @@ Build-Depends:
   devscripts,
   dh-apparmor,
   dh-python,
+  pybuild-plugin-pyproject,
   python3-all,
   python3-setuptools,
   python3-sphinx

diff --git a/debian/controlX/control.jammy b/debian/controlX/control.jammy
@@ -7,6 +7,7 @@ Build-Depends:
   devscripts,
   dh-apparmor,
   dh-python,
+  pybuild-plugin-pyproject,
   python3-all,
   python3-setuptools,
   python3-sphinx

diff --git a/debian/controlX/control.noble b/debian/controlX/control.noble
@@ -7,6 +7,7 @@ Build-Depends:
   devscripts,
   dh-apparmor,
   dh-python,
+  pybuild-plugin-pyproject,
   python3-all,
   python3-setuptools,
   python3-sphinx

diff --git a/documentation/developer/Environment.rst b/documentation/developer/Environment.rst
@@ -15,6 +15,7 @@ The guide assumes you run a Debian based system and that the following software
 * grunt-cli
 * node
 * npm
+* pybuild-plugin-pyproject
 * python3
 * python3-dev
 * python3-pip