pyproject.toml, new installation tool, improve github workflows (#1221)

Author: sezanzeb

.github/workflows/installation.yml

@@ -0,0 +1,80 @@
+name: Installation
+
+on: [push, pull_request]
+
+jobs:
+  deb:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    steps:
+    - uses: actions/checkout@v3
+    - name: Install .deb
+      run: |
+        sudo apt update
+
+        # build dependencies
+        sudo apt install gettext -y
+
+        sudo scripts/build-deb.sh
+        find build
+        sudo apt install -f ./dist/input-remapper-*.deb
+    - name: DBus Hello
+      run: |
+        # Test if files have been placed at the correct places in ubuntus file system.
+        # By sending the hello command, we tests the service file, binaries and module
+
+        # Make sure we aren't just importing the module from the cloned repo in the
+        # cwd. Commands should import the installed package
+        cd /
+        [ ! -d "inputremapper" ]
+
+        # Need to use sudo, because sys.path is weird in the ci otherwise
+        sudo input-remapper-control --command hello 2>&1 | grep 'Daemon answered with "hello"'
+
+  generic:
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    steps:
+    - uses: actions/checkout@v3
+    - name: Generic installation
+      run: |
+        sudo scripts/ci-install-deps.sh
+
+        # Check if the generic installation method works too. Also, using `--root /`
+        # should not break the system somehow
+        sudo python3 -m install --root /
+
+        sudo systemctl daemon-reload
+        sudo systemctl restart input-remapper
+    - name: DBus Hello
+      run: |
+        # Make sure we aren't just importing the module from the cloned repo in the
+        # cwd. Commands should import the installed package
+        cd /
+        [ ! -d "inputremapper" ]
+        sudo input-remapper-control --command hello 2>&1 | grep 'Daemon answered with "hello"'
+    - name: uninstall
+      run: |
+        cd $GITHUB_WORKSPACE
+
+        printf y | sudo python3 -m install.uninstall
+
+        if pip show input-remapper; then
+            echo "Expected input-remapper package to be uninstalled"
+            exit 1
+        fi
+
+        if [ -f /usr/share/dbus-1/system.d/inputremapper.Control.conf ]; then
+            echo "Expected input-remappers files to be removed"
+            exit 1
+        fi
+
+        if pgrep -f input-remapper; then
+            echo "Expected input-remapper processes to not be running"
+            exit 1
+        fi
+
+        if systemctl list-unit-files input-remapper.service; then
+            echo "Expected input-remapper service to be missing"
+            exit 1
+        fi

.github/workflows/lint.yml

@@ -3,25 +3,26 @@ name: Lint
 on: [push, pull_request]
 
 jobs:
-  black:
+  lint:
     runs-on: ubuntu-latest
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
-    strategy:
-      matrix:
-        python-version: ["3.11"]
     steps:
     - uses: actions/checkout@v3
-    - name: Set up Python ${{ matrix.python-version }}
+    - name: Set up Python 3.14
       uses: actions/setup-python@v4
       with:
-        python-version: ${{ matrix.python-version }}
+        python-version: 3.14
         cache: 'pip'
-        cache-dependency-path: setup.py
+        cache-dependency-path: pyproject.toml
     - name: Install dependencies
       run: |
         scripts/ci-install-deps.sh
-        pip install black
-    - name: Analysing the code with black --check --diff
+        pip install black ruff
+    - name: black --check --diff
       run: |
         black --version
         black --check --diff ./inputremapper ./tests
+    - name: ruff
+      run: |
+        ruff --version
+        ruff check ./inputremapper ./install

.github/workflows/reviewdog.yml

@@ -20,15 +20,15 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
-          cache-dependency-path: setup.py
+          cache-dependency-path: pyproject.toml
       - uses: reviewdog/action-setup@master
         with:
           reviewdog_version: latest
       - name: Install dependencies
         shell: bash
         run: |
           scripts/ci-install-deps.sh
-          pip install flake8 pylint mypy black types-setuptools
+          pip install flake8 pylint mypy black
       - name: Set env for PR
         if: github.event_name == 'pull_request'
         shell: bash

.github/workflows/test.yml

@@ -9,7 +9,7 @@ jobs:
     if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
     strategy:
       matrix:
-        python-version: ["3.8", "3.14"] # min and max supported versions?
+        python-version: ["3.10", "3.13"] # min and max supported versions
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
@@ -18,20 +18,19 @@ jobs:
         python-version: ${{ matrix.python-version }}
         # broken "Error: Cache folder path is retrieved for pip but doesn't exist on disk: /home/runner/.cache/pip"
         # cache: 'pip'
-        # cache-dependency-path: setup.py
+        # cache-dependency-path: pyproject.toml
     - name: Install dependencies
       run: |
-        # Install deps as root since we will run tests as root
-        sudo scripts/ci-install-deps.sh
-        sudo pip install .
+        # see https://pygobject.gnome.org/getting_started.html
+        sudo apt update
+        sudo apt install \
+            libgirepository-2.0-dev gcc libcairo2-dev pkg-config python3-dev \
+            libgtk-3-dev gir1.2-gtk-3.0 gir1.2-gtksource-4 gobject-introspection
+        pip install -e .
     - name: Run tests
       run: |
-        # FIXME: Had some permissions issues, currently worked around by running tests as root
-        mkdir test_tmp
-        export TMPDIR="$(realpath test_tmp)"
+        # Don't run tests as root, otherwise (I think) they run on the systems python
+        # version (3.12 currently)
+        python3 --version
 
-        export DATA_DIR="/home/runner/work/input-remapper/input-remapper/data/"
-        # try this if input-remappers data cannot be found, and set DATA_DIR to a matching directory
-        # find / -type f -name "input-remapper.glade"
-
-        sudo -E python -m unittest discover tests/unit
+        python -m unittest discover tests/unit

.gitignore

@@ -1,4 +1,3 @@
-inputremapper/commit_hash.py
 mo
 
 *.glade~

.mypy.ini

@@ -1,7 +1,3 @@
- 
 [mypy]
 plugins = pydantic.mypy
-
-# ignore the missing evdev stubs
-[mypy-evdev.*]
 ignore_missing_imports = True

.reviewdog.yml

@@ -2,7 +2,7 @@
 runner:
   mypy:
     name: mypy
-    cmd: mypy --show-column-numbers inputremapper tests --ignore-missing-imports
+    cmd: mypy --show-column-numbers inputremapper tests install --ignore-missing-imports
     errorformat:
       - "%f:%l:%c: %m"
 

DEBIAN/control

@@ -2,7 +2,7 @@ Package: input-remapper
 Version: 2.2.0
 Architecture: all
 Maintainer: Sezanzeb <[email protected]>
-Depends: build-essential, libpython3-dev, libdbus-1-dev, python3, python3-setuptools, python3-evdev, python3-dasbus, python3-gi, gettext, python3-cairo, libgtk-3-0, libgtksourceview-4-dev, python3-pydantic, python3-packaging, python3-psutil
+Depends: build-essential, libpython3-dev, libdbus-1-dev, python3, python3-evdev, python3-dasbus, python3-gi, gettext, python3-cairo, libgtk-3-0, libgtksourceview-4-dev, python3-pydantic, python3-packaging, python3-psutil
 Description: A tool to change the mapping of your input device buttons
 Replaces: python3-key-mapper, key-mapper, input-remapper-gtk, input-remapper-daemon, python3-inputremapper
 Conflicts: python3-key-mapper, key-mapper, input-remapper-gtk, input-remapper-daemon, python3-inputremapper

README.md

@@ -27,26 +27,26 @@
 
 Either download an installable .deb file from the [latest release](https://github.com/sezanzeb/input-remapper/releases):
 
-```bash
+```sh
 wget https://github.com/sezanzeb/input-remapper/releases/download/2.2.0/input-remapper-2.2.0.deb
 sudo apt install -f ./input-remapper-2.2.0.deb
 ```
 
 Or install the very latest changes via:
 
-```bash
-sudo apt install git python3-setuptools gettext
+```sh
+sudo apt install git gettext
 git clone https://github.com/sezanzeb/input-remapper.git
 cd input-remapper
-./scripts/build.sh
+./scripts/build-deb.sh
 sudo apt purge input-remapper input-remapper-daemon input-remapper-gtk python3-inputremapper
 sudo apt install -f ./dist/input-remapper-2.2.0.deb
 ```
 
 Input Remapper is also available in the repositories of [Debian](https://tracker.debian.org/pkg/input-remapper)
 and [Ubuntu](https://packages.ubuntu.com/oracular/input-remapper) via
 
-```bash
+```sh
 sudo apt install input-remapper
 ```
 
@@ -56,7 +56,7 @@ Input Remapper ≥ 2.0 requires at least Ubuntu 22.04.
 
 ### Fedora
 
-```bash
+```sh
 sudo dnf install input-remapper
 sudo systemctl enable --now input-remapper
 ```
@@ -65,7 +65,7 @@ sudo systemctl enable --now input-remapper
 
 ### Arch
 
-```bash
+```sh
 yay -S input-remapper-git
 sudo systemctl enable --now input-remapper
 ```
@@ -82,13 +82,19 @@ You can also use pip to install some of them. Python packages need to be install
 globally for the service to be able to import them. Don't use `--user`. Conda and such
 may also cause problems due to changed python paths and versions.
 
-```bash
-sudo pip install evdev pydantic dasbus PyGObject setuptools
+```sh
+sudo pip install evdev pydantic dasbus PyGObject
 ```
 
-```bash
+```sh
 git clone https://github.com/sezanzeb/input-remapper.git
 cd input-remapper
-sudo python3 setup.py install
+sudo python3 -m install --root /
 sudo systemctl enable --now input-remapper
 ```
+
+To uninstall:
+
+```sh
+sudo python3 -m install.uninstall
+```

bin/input-remapper-control

@@ -23,27 +23,8 @@
 import os
 import sys
 
-
-def fix_import_path():
-    # Installations via `sudo python3 setup.py install` install into /usr/local/lib
-    # instead of /usr/local. sys.path is missing /usr/local/lib when udev is running
-    # its rules.
-    try:
-        import inputremapper
-    except ModuleNotFoundError:
-        python_folder = f"python{sys.version_info.major}.{sys.version_info.minor}"
-        usr_local_lib = f"/usr/local/lib/{python_folder}/dist-packages"
-        if not os.path.exists(usr_local_lib):
-            return
-
-        print(f'Appending "{usr_local_lib}" to sys.path')
-        sys.path.append(usr_local_lib)
-
-
-fix_import_path()
-
-
 from inputremapper.bin.input_remapper_control import InputRemapperControlBin
 
+
 if __name__ == "__main__":
     InputRemapperControlBin.main(InputRemapperControlBin.parse_args())