Refactor README generation workflow and improve GlInet class document…

.github/workflows/build_deploy_pages.yml

@@ -33,17 +33,16 @@ jobs:
         uses: actions/checkout@v3
       - name: Install dependencies
         run: |
-          sudo apt-get update; sudo apt-get install python3 python3-venv;\
-          python -m venv venv;source venv/bin/activate;\
-          pip install -r docs/requirements.txt
-          pip install .
+          sudo apt-get update; sudo apt-get install python3
+          pip install uv
+          uv sync
       - name: Sphinx Build
         # You may pin to the exact commit or the version.
         # uses: ammaraskar/sphinx-action@8b4f60114d7fd1faeba1a712269168508d4750d2
         #uses: ammaraskar/sphinx-action@0.4
-        run: source venv/bin/activate; cd docs; make html; cd ..
-      - name: Move ressources to html folder
-        run: echo "$(ls -l docs/_build/html)";echo "Current user is $(id)";cp -r ressources docs/_build/html
+        run: source .venv/bin/activate; cd docs; make html; cd ..
+      - name: Move resources to html folder
+        run: echo "$(ls -l docs/_build/html)";echo "Current user is $(id)";cp -r resources docs/_build/html
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3
         with:

.github/workflows/generate_readme.yml

@@ -4,7 +4,9 @@ name: Generate Markdown Readme
 on:
   # Runs on pushes targeting the default branch
   push:
-    branches: ["main"]
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
@@ -23,6 +25,8 @@ jobs:
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
+        with:
+          ref: ${{ github.head_ref }}
       - name: Convert to Markdown
         run: |
           sudo apt-get install pandoc
@@ -33,6 +37,10 @@ jobs:
           git config --global user.name 'GH Action'
           git config --global user.email 'python@tomtana.net'
           git add README.md
-          git diff-index --quiet HEAD || git commit -m "auto README.md generation"
-          git push
+          git commit -m "Auto-update README.md" || echo "No changes to commit"
+          if [ "${{ github.event_name }}" = "pull_request" ]; then
+            git push origin HEAD:${{ github.head_ref }}
+          else
+            git push origin HEAD:${GITHUB_REF#refs/heads/}
+          fi
 

.github/workflows/python-coverage.yml

@@ -28,11 +28,11 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pytest
-        if [ -f tests/requirements.txt ]; then pip install -r tests/requirements.txt; fi
-        if [ -f setup.py ]; then pip install .; fi
+        python -m pip install uv
+        uv sync
     - name: Generate coverage report
       run: |
+        source .venv/bin/activate
         echo "$(ls -la)"
         echo "$(pwd)"
         cd tests

.github/workflows/python-package.yml

@@ -17,13 +17,13 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13", "3.14"]
         os: [ubuntu-latest, macos-latest, windows-latest]
         exclude:
           - os: macos-latest
-            python-version: ["3.8", "3.9"]
+            python-version: ["3.9"]
           - os: windows-latest
-            python-version: ["3.8", "3.9"]
+            python-version: ["3.9"]
 
     steps:
     - uses: actions/checkout@v3
@@ -32,18 +32,20 @@ jobs:
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
+      shell: bash
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pytest
-        pip install -r tests/requirements.txt;
-        pip install .
-    - name: Lint with flake8
+        python -m pip install uv
+        uv sync
+        source .venv/bin/activate || source .venv/Scripts/activate
+        echo PATH=$PATH >> $GITHUB_ENV
+        pre-commit install
+    - name: Lint with ruff
+      shell: bash
       run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        pre-commit run -a || exit 1
     - name: Test with pytest
+      shell: bash
       run: |
         pytest
   buildall:
@@ -54,4 +56,5 @@ jobs:
     steps:
       - name: Check build matrix status
         if: ${{ needs.build.result != 'success' }}
+        shell: bash
         run: exit 1

.github/workflows/python-publish.yml

@@ -19,6 +19,7 @@ jobs:
   deploy:
     name: publish_pip
     runs-on: ubuntu-latest
+
 
     steps:
     - uses: actions/checkout@v3
@@ -29,9 +30,12 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install build
+        pip install uv
+        uv sync
     - name: Build package
-      run: python -m build
+      run: |
+        source .venv/bin/activate
+        python -m build
     - name: Publish package
       uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
       with:

.gitignore

@@ -1,4 +1,10 @@
 /venv/
+.venv/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+*.egg-info/
+*.egg
 .idea
 __*/
 /python_glinet.egg-info/*

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.14.0
+  hooks:
+    # Run the linter.
+    - id: ruff-check
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
+- repo: local
+  hooks:
+    - id: generate-readme
+      name: Generate README.md from README.rst
+      entry: |
+        bash -c '
+          if ! command -v pandoc >/dev/null 2>&1; then
+            echo "WARNING: pandoc is not installed. Please install it with: sudo apt-get install pandoc"
+            exit 0
+          fi
+          pandoc -s --filter docs/conversion_filter.py docs/README.rst -o README.md && git add README.md
+        '
+      language: system
+      files: ^docs/README\.rst$