ci: Provide project description for the PyPI packages (cvc5#11506)

The `readme` field sets the project’s description on PyPI.
ajreynol · Jan 10, 2025 · 4704b1c · 4704b1c
1 parent 5572abe
commit 4704b1c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/.github/workflows/package_pypi.yml b/.github/workflows/package_pypi.yml
@@ -88,10 +88,14 @@ jobs:
         mkdir -p build/src/api/python
         if [ "${{ matrix.gpl }}" == "true" ]; then
           sed -e 's/^name="cvc5"$/name="cvc5-gpl"/' \
+              -e 's/^\(description=".*\)"/\1 (GPL version)"/' \
+              -e 's/^\(readme = {text = ".*\)\(", content-type = "text\/plain"\)/\1 (GPL version)\2/' \
               -e 's/^license = {text = "/license = {text = "GPL-2.0-or-later AND GPL-3.0-or-later AND /' \
               ./src/api/python/pyproject.toml > ./build/src/api/python/pyproject.toml
         else
-          cp src/api/python/pyproject.toml build/src/api/python/
+          sed -e 's/^\(description=".*\)"/\1 (BSD version)"/' \
+              -e 's/^\(readme = {text = ".*\)\(", content-type = "text\/plain"\)/\1 (BSD version)\2/' \
+              ./src/api/python/pyproject.toml > ./build/src/api/python/pyproject.toml
         fi
         echo "::endgroup::"
 

diff --git a/src/api/python/pyproject.toml b/src/api/python/pyproject.toml
@@ -12,6 +12,7 @@ build-backend = "setuptools.build_meta"
 [project]
 name="cvc5"
 description="Python bindings for cvc5"
+readme = {text = "Python bindings for cvc5", content-type = "text/plain"}
 dynamic = ["version"]
 license = {text = "BSD-3-Clause AND LGPL-3.0-or-later AND MIT"}
 # BSD-3-Clause      : cvc5 library and Python API