build: add github workflow to build and publish to pypi

This is long overdue, but we should be publishing to pypi to amke the
program easier for people to install and use.

Author: philipl

.github/workflows/unittests.yml

@@ -3,8 +3,6 @@ name: Continuous Integration
 
 on:
   push:
-    branches:
-    - 'master'
   pull_request:
 
 jobs:
@@ -14,6 +12,8 @@ jobs:
 
     steps:
       - uses: actions/checkout@v4
+        with:
+          persist-credentials: false
       - name: Set up Python 3.9
         uses: actions/setup-python@v5
         with:
@@ -30,3 +30,59 @@ jobs:
       - name: Run unit tests
         run: |
           uv run pytest
+      - name: Build distribution artifacts
+        run: |
+          uv build
+      - name: Store artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distribution
+          path: dist/
+
+  publish-to-pypi:
+    name: Publish to PyPI
+    needs:
+      - continous-integration
+
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/evdevremapkeys
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+      - name: Publish distribution 📦 to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-to-testpypi:
+      name: Publish to TestPyPI
+      needs:
+        - continous-integration
+
+      runs-on: ubuntu-latest
+
+      environment:
+        name: testpypi
+        url: https://test.pypi.org/p/evdevremapkeys
+
+      permissions:
+        id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+      steps:
+      - name: Download all the dists
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distribution
+          path: dist/
+      - name: Publish distribution 📦 to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

README.md

@@ -45,13 +45,36 @@ client receives events, and then forward all un-modified events through
 your virtual device. It's annoying but unavoidable - you can't hide individual
 events from other clients.
 
-## libinput's lua plugin based future?
-
-In the years since I first wrote `evdevremapkeys`, there wasn'tt been any real
-movement towards exposing a meaningful remapping capability from libinput. In
-2025, they started development of a
-[lua](https://gitlab.freedesktop.org/libinput/libinput/-/merge_requests/1192)
-plugin framework, which might turn out to be a real solution. When that lands,
-and as long as it doesn't depend on the Wayland compositor to expose access to
-it, it might turn out to be a better long term approach. But it's too early to
-say right now.
+# Software Setup
+
+## Install from PyPI
+
+The recommended way to install the program is to use `pipx`.
+
+```bash
+$ pipx install evdevremapkeys
+```
+
+You can also use `pip`, but on modern distros, `pipx` is a far better experience.
+
+## Create a configuration
+
+You will need to create an initial configuration file for the program to be
+able to run and doing anything useful.
+
+It's recommended to start from one of the
+[example](https://github.com/philipl/evdevremapkeys/tree/master/examples) config
+files and adapt it for your hardware and the remapping you need.
+
+Place your final file at: `~/.config/evdevremapkeys/config.yml`
+
+## Run the program
+
+```bash
+evdevremapkeys
+```
+
+## More details
+
+See [RUNNING.md](https://github.com/philipl/evdevremapkeys/blob/master/RUNNING.md) for
+more details.

RUNNING.md

@@ -31,6 +31,16 @@ is all handled by logind/systemd/X automatically.
 
 # Software Setup
 
+## Install from PyPI
+
+The recommended way to install the program is to use `pipx`.
+
+```bash
+$ pipx install evdevremapkeys
+```
+
+You can also use `pip`, but on modern distros, `pipx` is a far better experience.
+
 ## Prerequisites
 
 This project uses [uv](https://docs.astral.sh/uv/) to build and run. You will need to install
@@ -66,6 +76,9 @@ or
 $ pipx install <source-tarball>
 ```
 
+If you are trying to do active developing, installing with `--editable` will cause the
+installation to always reflect your changes.
+
 ## Building a self-contained executable
 
 You will not usually need a self-contained executable, given the existing options for running