v0.18.0

.github/workflows/build_appimage_bundle.yml

@@ -7,15 +7,15 @@ jobs:
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up Python 3.13
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
       - name: Install Node.js, NPM and Yarn
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: 24
 
@@ -35,7 +35,7 @@ jobs:
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          pip install .[nuitka]
 
       - name: Build binaries
         working-directory: freedata_server
@@ -114,7 +114,7 @@ jobs:
 
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: 'FreeDATA-x86_64.AppImage'
           path: FreeDATA-x86_64.AppImage

.github/workflows/build_docker_image.yml

@@ -8,7 +8,7 @@ jobs:
     name: Build image and upload artifact
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
@@ -25,7 +25,7 @@ jobs:
 
       # Upload the image tarball as an artifact.
       - name: Upload Docker image artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: freedata-image
           path: freedata.tar
@@ -40,7 +40,7 @@ jobs:
       contents: read
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3

.github/workflows/build_nsis_bundle.yml

@@ -7,18 +7,18 @@ jobs:
 
     steps:
       - name: Check out repository
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Set up Python 3.13
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
       - name: Install NSIS via choco
         run: choco install nsis
 
       - name: Install Node.js, NPM and Yarn
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: 24
 
@@ -34,7 +34,7 @@ jobs:
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          pip install .[nuitka]
 
       - uses: robinraju/release-downloader@v1.12
         with:
@@ -92,7 +92,7 @@ jobs:
         run: ls -R
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: 'FreeDATA-Installer'
           path: ./FreeDATA-Installer.exe

.github/workflows/build_server.yml

@@ -27,12 +27,12 @@ jobs:
 
     steps:
       - name: Checkout code for ${{ matrix.platform.name }}
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
         with:
           repository: DJ2LS/FreeDATA
 
       - name: Install Node.js, NPM and Yarn
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: 24
 
@@ -43,7 +43,7 @@ jobs:
           npm run build
 
       - name: Set up Python 3.13
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: "3.13"
 
@@ -62,7 +62,7 @@ jobs:
       - name: Install Python dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install -r requirements.txt
+          pip install .[nuitka]
 
       - name: Add MacOS certs
         if: ${{startsWith(matrix.os, 'macos')}}
@@ -117,7 +117,7 @@ jobs:
         run: ls -R
 
       - name: Upload artifact
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v6
         with:
           name: '${{ matrix.zip_name }}'
           path: ./freedata_server/server.dist/${{ matrix.zip_name }}.zip

.github/workflows/codeql-analysis.yml

@@ -39,13 +39,13 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v5
+      uses: actions/checkout@v6
       with:
         ref: ${{ github.head_ref }}
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v3
+      uses: github/codeql-action/init@v4
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -56,7 +56,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v3
+      uses: github/codeql-action/autobuild@v4
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 https://git.io/JvXDl
@@ -70,4 +70,4 @@ jobs:
     #   make release
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v3
+      uses: github/codeql-action/analyze@v4

.github/workflows/gui_tests.yml

@@ -23,9 +23,9 @@ jobs:
           - node-version: "24"
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Install Node.js, NPM and Yarn
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: ${{ matrix.node-version }}
 

.github/workflows/modem_tests.yml

@@ -17,18 +17,18 @@ jobs:
       matrix:
         include:
           #- python-version: "3.7" EOL
-          - python-version: "3.8"
-          - python-version: "3.9"
+          #- python-version: "3.8" EOL
+          #- python-version: "3.9" EOL
           - python-version: "3.10"
           - python-version: "3.11"
           - python-version: "3.12"
           - python-version: "3.13"
 
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v5
+        uses: actions/setup-python@v6
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -42,9 +42,9 @@ jobs:
       - name: Install python packages
         shell: bash
         run: |
-          pip3 install -r requirements.txt
+          pip install .[test]
 
       - name: run config tests
         shell: bash
         run: |
-          python -m unittest discover tests
+          python -m unittest discover tests

.github/workflows/pip_package.yml

@@ -5,15 +5,15 @@ jobs:
   deploy:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
 
     - name: Set up Python 3.13
-      uses: actions/setup-python@v5
+      uses: actions/setup-python@v6
       with:
         python-version: "3.13"
 
     - name: Install Node.js, NPM and Yarn
-      uses: actions/setup-node@v4
+      uses: actions/setup-node@v6
       with:
         node-version: 24
 
@@ -24,8 +24,7 @@ jobs:
     - name: Install Python dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
-        pip install wheel
+        pip install .[build]
 
     - name: Build GUI
       working-directory: freedata_gui
@@ -35,7 +34,7 @@ jobs:
 
     - name: Build package
       run: |
-        python setup.py sdist bdist_wheel
+        python -m build
 
     - name: Publish to PyPI
       uses: pypa/gh-action-pypi-publish@v1.13.0

.github/workflows/prettier.yaml

@@ -12,7 +12,7 @@ jobs:
 
         steps:
             - name: Checkout
-              uses: actions/checkout@v5
+              uses: actions/checkout@v6
               with:
                   # Make sure the actual branch is checked out when running on pull requests
                   ref: ${{ github.head_ref }}

.github/workflows/ruff.yaml

@@ -0,0 +1,33 @@
+name: "Ruff"
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'develop'
+    paths:
+      - '**.py'
+      - 'pyproject.toml'
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+  merge_group:
+  workflow_dispatch:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+      - name: Run Ruff check
+        run: ruff check --output-format=github .
+      - name: Run Ruff Format
+        # TODO: remove `--preview` when `--output-format=github` stabilizes for the format action
+        run: ruff format --check --preview --output-format=github .

.gitignore

@@ -35,3 +35,7 @@ venv_3.11/
 venv/
 test_venv/
 freedata_server/lib/codec2/codec2/
+
+# `python -m build` artifacts
+/dist/
+/*.egg-info/

CONTRIBUTING.md

@@ -0,0 +1,58 @@
+# Contribution Guide
+
+## Required Tools and Dependencies
+
+The backend of FreeDATA is built with python, with a couple dependencies written
+in C/C++, and the frontend is build with VueJS, so you will need Python (from
+3.10 to 3.13) to work on the backend, and node+npm to work on the frontend.
+
+System dependencies required:
+  - python3 (with virtual environment support)
+  - portaudio
+  - hamlib (optional, there is a vendored version bundled with the freedata
+    server, or you can build it from source)
+  - nodejs + npm
+
+Example for debian trixie: `sudo apt update && sudo apt install python3
+python3-venv nodejs npm portaudio19-dev`
+
+Example for MacOS: `brew install python pyenv-virtualenv npm node@24 portaudio`
+
+To fetch the python dependencies create a virtual environment and next use pip:
+
+- Create a virtual environment: `python -m venv venv`
+- Load the virtual environment `source venv/bin/activate`
+- There are several sets of dependencies you can install:
+  - `pip install .` installs only the libraries required to run freedata
+  - `pip install .[test]` installs the libraries required for running and testing
+    freedata
+  - `pip install .[dev]` installs the libraries required for running, testing
+    and linting/checking freedata
+  - `pip install .[build]` installs only the libraries required to run and build
+    the freedata pip module
+  - `pip install .[nuitka]` installs only the libraries required to run and
+    build the freedata windows executable
+
+To fetch the `npm` dependencies go inside `./freedata_gui` and run `npm
+install`. See `./freedata_gui/README.md` for additional informations.
+
+## Linting and Formatting (python-only)
+The python sources must be formatted and checked using `ruff`. There is a CI
+workflow that block all PRs that do not pass the linter/formatter checks.
+
+- To check formatting run `ruff format --check` (lists file that needs formatting)
+- To see what the automatic formatter will change run `ruff format --preview
+--diff` (shows diff-style changes).
+- To automatically format files run `ruff format --preview`
+
+NOTE: the `--preview` enables new auto-formatting actions and enables a feature
+usefull in the CI. In the future it will no longer be necessary
+
+- To run the checker/linter execute `ruff check`
+- Some errors can be automatically fixed running `ruff check --fix`, but always
+  check and test the changes made by ruff. There are errors that ruff cannot safely
+  fix automatically, you must fix them manually.
+
+## Testing backend
+To run the backend tests run inside the virtual environment `python -m unittest
+discover tests`

Dockerfile

@@ -40,8 +40,7 @@ ADD https://github.com/DJ2LS/FreeDATA.git#v0.16.10-alpha ./
 RUN python3 -m venv /app/FreeDATA/venv
 ENV PATH="/app/FreeDATA/venv/bin:$PATH"
 
-RUN pip install --no-cache-dir --upgrade pip wheel && \
-  pip install --no-cache-dir -r requirements.txt
+RUN pip install --no-cache-dir --upgrade pip .
 
 WORKDIR /app/FreeDATA/freedata_server/lib