Document and add a job to build and publish a PyPI package

The job will build the Python package on every PR and every push,
but will only publish it to the official PyPI repository when we
push a new tag.

Fixes #84

Author: ldionne

.github/workflows/build-and-publish-package.yml

@@ -0,0 +1,70 @@
+name: Build and publish Python distribution package to PyPI and TestPyPI
+
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Build LNT distribution package
+    steps:
+    - uses: actions/checkout@v5
+      with:
+        persist-credentials: false
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+    - name: Build the source tarball
+      run: |
+        python -m pip install build
+        python -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+
+  publish-to-testpypi:
+    runs-on: ubuntu-latest
+    name: Publish LNT package to TestPyPI
+    needs: [build]
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/llvm-lnt
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download distributions
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish LNT to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/
+
+
+  publish-to-pypi:
+    runs-on: ubuntu-latest
+    name: Publish LNT package to PyPI
+    if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
+    needs: [build]
+    environment:
+      name: pypi
+      url: https://pypi.org/p/llvm-lnt
+    permissions:
+      id-token: write
+
+    steps:
+    - name: Download distributions
+      uses: actions/download-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+    - name: Publish LNT to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

docs/developer_guide.rst

@@ -72,3 +72,18 @@ default. You can enable them by passing additional flags to lit:
 Example::
 
     lit -sv -Dpostgres=1 -Dmysql=1 -Dtidylib=1 ./tests
+
+Publishing a new version of LNT
+-------------------------------
+
+We publish a new version of the LNT package on a regular basis. This is done automatically via a Github
+Action whenever a commit is tagged. However, publishing can also be done manually. To do so, make sure you
+install the development dependencies, and then run the following commands from the virtual environment::
+
+    rm -rf dist
+    python -m build
+    python -m twine upload --repository testpypi dist/*
+
+This requires setting up the right API token, see `the official documentation <https://packaging.python.org/en/latest/tutorials/packaging-projects/#uploading-the-distribution-archives>`_
+for details. You can replace ``--repository testpypi`` with ``--repository pypi`` once you are actually ready
+to publish the package.

docs/quickstart.rst

@@ -9,25 +9,17 @@ interested in using LNT to test compilers using the LLVM test-suite.
 Installation
 ------------
 
-The first thing to do is to checkout install the LNT software itself. The
-following steps should suffice on any modern Unix variant:
+You can install the latest stable release of LNT from PyPI. We recommend doing
+that from a virtual environment::
 
-#. Checkout the LNT sources::
+    python3 -m venv .venv
+    source .venv/bin/activate
+    pip install llvm-lnt
 
-            git clone https://github.com/llvm/llvm-lnt.git ~/lnt
+This will install the client-side tools. If you also want to run a production
+server, you should instead include the server-side optional requirements::
 
-#. Create a new virtual environment for the LNT application and activate it::
-
-            python3 -m venv .venv
-            source .venv/bin/activate
-
-#. Install LNT into the virtual environment::
-
-            pip install -r requirements.txt
-
-Note that if you only want to use the client-side features of ``lnt``, you can
-install the requirements specified in ``requirements.client.txt`` instead, which
-are a bit more lightweight.
+    pip install "llvm-lnt[server]"
 
 That's it! ``lnt`` should now be accessible from the virtual environment.
 

pyproject.toml

@@ -60,11 +60,13 @@ server = [
     "psycopg2>=2.9.0",
 ]
 dev = [
+    "build",
     "filecheck",
     "Flake8-pyproject",
     "flake8",
     "lit",
     "tox",
+    "twine",
 ]
 
 [tool.setuptools]