WEEE-Open
diff --git a/‎.env.example
Lines changed: 2 additions & 0 deletions b/‎.env.example
Lines changed: 2 additions & 0 deletions
diff --git a/‎.envrc
Lines changed: 1 addition & 0 deletions b/‎.envrc
Lines changed: 1 addition & 0 deletions
diff --git a/‎.github/workflows/lint.yml
Lines changed: 5 additions & 5 deletions b/‎.github/workflows/lint.yml
Lines changed: 5 additions & 5 deletions
diff --git a/‎.github/workflows/publish.yml
Lines changed: 52 additions & 0 deletions b/‎.github/workflows/publish.yml
Lines changed: 52 additions & 0 deletions
diff --git a/‎.github/workflows/python-tests.yml
Lines changed: 39 additions & 26 deletions b/‎.github/workflows/python-tests.yml
Lines changed: 39 additions & 26 deletions
diff --git a/‎.gitignore
Lines changed: 10 additions & 0 deletions b/‎.gitignore
Lines changed: 10 additions & 0 deletions
diff --git a/‎.pre-commit-config.yaml
Lines changed: 15 additions & 0 deletions b/‎.pre-commit-config.yaml
Lines changed: 15 additions & 0 deletions
diff --git a/‎Dockerfile
Lines changed: 0 additions & 15 deletions b/‎Dockerfile
Lines changed: 0 additions & 15 deletions
diff --git a/‎Installing.py
Lines changed: 0 additions & 37 deletions b/‎Installing.py
Lines changed: 0 additions & 37 deletions
diff --git a/‎Makefile
Lines changed: 0 additions & 17 deletions b/‎Makefile
Lines changed: 0 additions & 17 deletions
diff --git a/‎README.md
Lines changed: 12 additions & 31 deletions b/‎README.md
Lines changed: 12 additions & 31 deletions
diff --git a/‎TODO.md
Lines changed: 12 additions & 0 deletions b/‎TODO.md
Lines changed: 12 additions & 0 deletions
@@ -3,3 +3,5 @@ export TARALLO_TOKEN=yoLeCHmEhNNseN0BlG0s3A:ksfPYziGg7ebj0goT0Zc7pbmQEIYvZpRTIkw
 export TARALLO_FEATURES_AUTO_DOWNLOAD=1
 export GENERATE_FILES_USE_SUDO=1
 export GENERATE_FILES_ASK_SUDO_PASSWORD=1
+export AUTOMATIC_REPORT_ERRORS=1
+export REPORT_URL=http://127.0.0.1:9999
@@ -0,0 +1 @@
+use flake
@@ -12,18 +12,18 @@ jobs:
 
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v1
+        uses: actions/setup-python@v5
         with:
           python-version: 3.8
 
       - name: Install Python dependencies
-        run: pip install black flake8
-        
+        run: pip install black
+
       - name: Run linters
-        uses: wearerequired/lint-action@v1
+        uses: wearerequired/lint-action@v2
         with:
           black: true
           flake8: false
 
@@ -0,0 +1,52 @@
+name: Publish Python 🐍 distribution 📦 to PyPI
+
+on:
+    push:
+        tags:
+            - 'v*'
+
+jobs:
+  build:
+    name: Build distribution 📦
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install pypa/build
+      run: >-
+        python3 -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: python3 -m build
+    - name: Store the distribution packages
+      uses: actions/upload-artifact@v4
+      with:
+        name: python-package-distributions
+        path: dist/
+
+  publish-to-pypi:
+    name: >-
+      Publish Python 🐍 distribution 📦 to PyPI
+    if: startsWith(github.ref, 'refs/tags/')  # only publish to PyPI on tag pushes
+    needs:
+    - build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/peracotta  # Replace <package-name> with your PyPI project name
+    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
@@ -9,45 +9,58 @@ on:
 jobs:
 
   run-tests:
-
-    runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: [ '3.8', '3.9', '3.10', '3.11' ]
+        os: [ubuntu-latest]
+        python-version: [ '3.9', '3.10', '3.11', '3.12' ]
+    runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v4
 
       - name: Set up Python version ${{ matrix.python-version }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           architecture: x64
-      
+
       - name: Install dev dependencies
-        run: pip install -r requirements-dev.txt
+        run: |
+          sudo apt install build-essential libpython3-dev libdbus-1-dev
+          pip install -r requirements-dev.txt
 
-      - name: Install dataclasses on Python 3.6
-        run: pip install dataclasses
-        if: matrix.python-version == '3.6'
+      #- name: Install dev dependencies
+      #  run: |
+      #    # Add Docker's official GPG key:
+      #    sudo apt-get update
+      #    sudo apt-get install ca-certificates curl
+      #    sudo install -m 0755 -d /etc/apt/keyrings
+      #    sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
+      #    sudo chmod a+r /etc/apt/keyrings/docker.asc
 
-      - name: Set up local development Tarallo instance
-        run: |
-          git clone https://github.com/weee-open/tarallo
-          cd tarallo || exit
-          make ci
-          make up
-          cd - &> /dev/null
-          
-      - name: Create test .env file to access local Tarallo instance
-        run: |
-          echo "export TARALLO_URL=http://127.0.0.1:8080" >> .env
-          echo "export TARALLO_TOKEN=yoLeCHmEhNNseN0BlG0s3A:ksfPYziGg7ebj0goT0Zc7pbmQEIYvZpRTIkwuscAM_k" >> .env
+      #    # Add the repository to Apt sources:
+      #    echo \
+      #      "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
+      #      $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
+      #      sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
+      #    sudo apt-get update
+      #    sudo apt install build-essential libpython3-dev libdbus-1-dev docker-ce docker-ce-cli containerd.io docker-compose-plugin
+      #    pip install -r requirements-dev.txt
+
+      #- name: Set up local development Tarallo instance
+      #  run: |
+      #    git clone https://github.com/weee-open/tarallo
+      #    cd tarallo || exit
+      #    docker-compose() { docker compose "$@"; } # tarallo's makefile has the older deprecated docker-compose command
+      #    export -f docker-compose
+      #    make ci
+      #    make up
+      #    cd - &> /dev/null
 
-#      - name: Run tests
-#        uses: GabrielBB/xvfb-action@v1
-#        with:
-#          run: pytest -vv tests
+      #- name: Run tests
+      #  uses: coactions/setup-xvfb@v1
+      #  with:
+      #    run: pytest -vv tests
 
       - name: Run tests
         run: pytest -vv tests -m "not gui"
@@ -1,6 +1,7 @@
 __pycache__/
 .idea/
 venv/
+.venv/
 dev_dmdi_files/
 .DS_Store
 __pycache__/
@@ -18,3 +19,12 @@ pera*.bin
 pera*.build
 pera*.dist
 pera*.onefile-build
+.vscode/
+publish.sh
+dist/
+build/
+*.egg-info
+logs
+*/*.log
+*.egg-info
+.direnv/
@@ -0,0 +1,15 @@
+# .pre-commit-config.yaml
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.6.0
+    hooks:
+    - id: check-yaml
+    - id: end-of-file-fixer
+    - id: trailing-whitespace
+  - repo: https://github.com/psf/black
+    rev: 24.4.1
+    hooks:
+      - id: black
+        language_version: python3.9
+        args:
+          - --target-version=py39
@@ -20,12 +20,12 @@ Launch `peracotta`: that is the GUI that allows you to gather data, parse it and
 
 ![Main peracotta window, displaying a motherboard](docs/peracotta_mobo_screenshot.png)
 
-Options can be configured in the left pane, then after Generate is pressed data is displayed in the right pane.  
+Options can be configured in the left pane, then after Generate is pressed data is displayed in the right pane.
 Some basic editing is possible (add and remove items and features, edit feature values). The result can be saved as a JSON or uploaded directly to tarallo.
 
 ### You are using a slow pc or you don't have PyQt installed
 
-Launch `peracruda` from the terminal: this a script that gathers and parses data, however it offers no editing capabilities.  
+Launch `peracruda` from the terminal: this a script that gathers and parses data, however it offers no editing capabilities.
 At the end, you can save data as a JSON or upload it to tarallo directly.
 
 The saved JSON can be uploaded to tarallo or imported from the `peracotta` GUI e.g. on another computer, to review and edit it before upload.
@@ -39,20 +39,8 @@ You can load those files in `peracruda` (`-f` option) or `peracotta` (`File > Lo
 ## How to install and run
 
 ```bash
-# Clone this repo
-git clone https://github.com/weee-open/peracotta
-
-# Make a virtual environment and activate it
-cd peracotta
-python3 -m venv venv
-source venv/bin/activate
-
-# Install the requirements
-pip install -r requirements.txt
-
-# Copy the example .env file and edit it to your liking
-cp .env.example .env
-nano .env
+sudo apt install libxcb-cursor-dev
+pip install peracotta
 ```
 
 ### Privileges and sudo
@@ -82,28 +70,21 @@ Add this to your .env:
 ```bash
 export GENERATE_FILES_USE_SUDO=0
 ```
-
-#### pkexec
-
-You can run `polkit.py` just once: it will configure pkexec to run generate_files.sh with root privileges. However, the configuration contains hardcoded absolute paths to your generate_files.sh script, so you cannot move it.
-
-Additionally, if anyone edits generate_files.sh, it will be executed with root privileges. Unless you move it to /sbin and change its owner to root:root, this is also not very secure.
-
 #### Manually
 
 Run `sudo generate_files.sh /path/to/output/directory` then load the raw files in peracruda or peracotta. This is probably the safest way, considering that generate_files.sh is pretty short so you can inspect it before running. Everything else will work as usual and won't require root permissions.
 
 ### How to develop
 
 Same as before, until the `pip install` part. Just install `requirements-dev.txt` instead:
-`pip install -r requirements-dev.txt`  
+`pip install -r requirements-dev.txt`
 
 This will allow you to run tests: `pytest -vv tests`
 
 Some markers are also available, e.g. you can run `pytest -m gui` to just test the gui, or `pytest -m 'not gui'` to test everything else. See `pytest.ini` for a list of markers.
 
-If requirements change:  
-- install the correct version of the requirements (e.g. a new library or a new version of an already installed library)  
+If requirements change:
+- install the correct version of the requirements (e.g. a new library or a new version of an already installed library)
 - with the virtual environment activated, run `pip freeze > requirements-dev.txt` and *manually* edit the file (add the `-r requirements.txt` line and remove non-dev requirements)
 
 If you can't run generate_files.sh because you don't have access to `sudo`, such as on our development VM, you can look at `tests/source_files` for examples.
@@ -118,7 +99,7 @@ You can find the usage below, but keep in mind that the three most important arg
 
 - the path for files generation: if none given, it will default to a tmp directory, and if it exists, you will be asked whether you want to overwrite it
 - `-g | -c | -b`: one of these tells the script where the GPU (or graphics card if it's not integrated) is located. If none of them is given, a menu with the same choices will appear during the execution.
-- `--code CODE` and `--owner OWNER`: these two parameters are used to add some more information directly into the output json file. 
+- `--code CODE` and `--owner OWNER`: these two parameters are used to add some more information directly into the output json file.
 - `-f` to read files from the path instead of calling `generate_files.sh` again.
 
 ```
@@ -150,12 +131,12 @@ Just need to run it with `./peracotta` or from your file manager. It does everyt
 
 ### generate_files.sh
 
-This will create some txt files with data related to the computer, that will be parsed by launching 
-`peracruda` with -f/--files argument. The hard work is powered by the many `read_X.py` scripts, which are the actual 
+This will create some txt files with data related to the computer, that will be parsed by launching
+`peracruda` with -f/--files argument. The hard work is powered by the many `read_X.py` scripts, which are the actual
 parsers.
 
-Install dependencies on Debian-based distributions (Debian, Ubuntu, Xubuntu, etc):  
-`sudo apt install pciutils i2c-tools mesa-utils smartmontools dmidecode`  
+Install dependencies on Debian-based distributions (Debian, Ubuntu, Xubuntu, etc):
+`sudo apt install pciutils i2c-tools mesa-utils smartmontools dmidecode`
 These are the actual programs that generate the files that we parse.
 
 ### parsers
 
@@ -0,0 +1,12 @@
+- [x] Known and non-fatal errors shouldn't crash the program.
+- [ ] Known and fatal errors should crash the program
+- [ ] Handle in-thread exceptions
+- [ ] Possibly use better sudo management (especially for devices with fingerprint)
+- [ ] Migrate to PySide6? Seems to have a better suppot for Nuitka
+- [ ] github Actions to auto-publish to PyPi
+- [ ] Check peracruda
+- [x] Add TOML config
+- [x] Fix logs
+- [ ] Properly credit Authors and Mantainers in README and pyproject
+- [x] Add crash feedback
+- [ ] Add tests