update branch dev with current main state

.github/workflows/buildexe.yml

@@ -0,0 +1,77 @@
+name: Build PyInstaller Executable
+
+on:
+    workflow_dispatch:
+jobs:
+    buildwindows:
+        runs-on: windows-latest
+
+        steps:
+        - name: Checkout repository
+          uses: actions/checkout@v4
+          with:
+            submodules: 'recursive'
+
+        - name: Set up Python
+          uses: actions/setup-python@v5
+          with:
+            python-version: '3.10'
+
+        - name: Install dependencies
+          run: |
+                python -m pip install --upgrade pip
+                pip install -r requirements.txt
+                pip install -r quality.txt
+
+        - name: Build executable
+          run: |
+                pyinstaller --noconfirm .\pyx2cscope_win.spec
+
+        - name: Create startWebInterface.bat
+          shell: cmd
+          run: |
+                echo pyX2Cscope.exe -w > dist\pyx2cscope\startWebInterface.bat
+
+        - name: Upload artifact
+          uses: actions/upload-artifact@v4
+          with:
+                name: pyX2Cscope-windows
+                path: dist/pyX2Cscope
+
+
+    buildlinux:
+        runs-on: ubuntu-latest
+
+        steps:
+        - name: Checkout repository
+          uses: actions/checkout@v4
+          with:
+            submodules: 'recursive'
+
+        - name: Set up Python
+          uses: actions/setup-python@v5
+          with:
+                python-version: '3.10'
+
+        - name: Install dependencies
+          run: |
+                python -m pip install --upgrade pip
+                pip install -r requirements.txt
+                pip install -r quality.txt
+                sudo apt install libxcb-xinerama0
+
+        - name: Build executable
+          run: |
+                pyinstaller --noconfirm ./pyx2cscope_linux.spec
+
+        - name: Create startWebInterface.sh
+          run: |
+                echo '#!/bin/bash' > dist/pyX2Cscope_linux/startWebInterface.sh
+                echo './pyX2Cscope_linux -w' >> dist/pyX2Cscope_linux/startWebInterface.sh
+                chmod +x dist/pyX2Cscope_linux/startWebInterface.sh
+
+        - name: Upload artifact
+          uses: actions/upload-artifact@v4
+          with:
+                name: pyX2Cscope-linux
+                path: dist/pyX2Cscope_linux

.github/workflows/documentation.yml

@@ -0,0 +1,136 @@
+name: Run format, Build Sphinx Documentation, tests
+
+on:
+  [pull_request]
+
+jobs:
+
+  format:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r quality.txt
+
+    - name: Code Format Check
+      run: |
+        ruff check .
+
+#  static-analysis:
+#    runs-on: ubuntu-latest
+#    steps:
+#    - uses: actions/checkout@v4
+#    - name: Set up Python
+#      uses: actions/setup-python@v5
+#      with:
+#        python-version: "3.10"
+#    - name: Install dependencies
+#      run: |
+#        python -m pip install --upgrade pip
+#        pip install -r quality.txt
+#    - name: Check code with ruff
+#      run: |
+#        ruff ./pyx2cscope
+#    - name: Check code with pylint
+#      run: |
+#        pylint ./pyx2cscope
+
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.10"
+
+# Since we moved to generic parser, we don't need to install the xc-16 compiler anymore,
+# because generic parser is based on pyelftools.
+#
+#    - name: Set up Microchip XC16 v2.10 compiler
+#      run: |
+#        wget -nv -O /tmp/xc16 https://ww1.microchip.com/downloads/aemDocuments/documents/DEV/ProductDocuments/SoftwareTools/xc16-v2.10-full-install-linux64-installer.run && \
+#        chmod +x /tmp/xc16 && \
+#        sudo /tmp/xc16 --mode unattended --unattendedmodeui none --netservername localhost --LicenseType FreeMode --prefix /opt/microchip/xc16/v2.10 && \
+#        rm /tmp/xc16
+#        echo "/opt/microchip/xc16/v2.10/bin" >> $GITHUB_PATH
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r quality.txt
+        pip install -e .
+
+    - name: Run tests
+      run: |
+        pytest 
+
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r quality.txt
+          pip install -e .
+
+      - name: Build documentation
+        run: |
+          sphinx-build -M html doc build --keep-going 
+
+  version-check:
+    runs-on: ubuntu-latest
+    if: github.base_ref == 'main'
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+
+    - name: Check version consistency
+      run: |
+        # Get version from pyproject.toml
+        PYPROJECT_VERSION=$(grep -oP 'version\s*=\s*"\K[^"]+' pyproject.toml)
+        # Get version from __init__.py
+        INIT_VERSION=$(grep -oP '__version__\s*=\s*["\x27]\K[^"\x27]+' pyx2cscope/__init__.py)
+
+        if [ "$PYPROJECT_VERSION" != "$INIT_VERSION" ]; then
+          echo "❌ Version mismatch between pyproject.toml ($PYPROJECT_VERSION) and __init__.py ($INIT_VERSION)"
+          echo "Run 'python scripts/update_version.py' to synchronize versions"
+          exit 1
+        fi
+        echo "✅ Version consistency verified: $PYPROJECT_VERSION"
+
+    - name: Check version has been updated
+      if: github.base_ref == 'main'
+      run: |
+        # Get PR version
+        PR_VERSION=$(grep -oP 'version\s*=\s*"\K[^"]+' pyproject.toml)
+
+        # Get main branch version
+        git fetch origin main:main
+        MAIN_VERSION=$(git show main:pyproject.toml | grep -oP 'version\s*=\s*"\K[^"]+')
+
+        if [ "$PR_VERSION" == "$MAIN_VERSION" ]; then
+          echo "❌ ERROR: Version in PR ($PR_VERSION) is the same as in main branch ($MAIN_VERSION)"
+          echo "Please update the version in pyproject.toml"
+          exit 1
+        fi
+        echo "✅ Version check passed: $PR_VERSION (PR) vs $MAIN_VERSION (main)"

.github/workflows/release.yml

@@ -0,0 +1,41 @@
+name: Deploy documentation and package
+on:
+  push:
+    branches:
+    - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r quality.txt
+          pip install -e .
+
+      - name: Build documentation
+        run: |
+          sphinx-build -M html doc build --keep-going 
+
+      - name: Deploy documentation
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build/html
+
+      - name: Release to pypi with poetry
+        run: |
+          poetry config pypi-token.pypi ${{ secrets.PYX2CSCOPE_PYPI }}
+          poetry publish -vvv --build
+
+

.gitignore

@@ -132,4 +132,13 @@ dmypy.json
 .vscode
 
 # pycharm
-.idea
+.idea
+!.idea/runConfigurations/*.xml
+/pyx2cscope/examples/scope_data.csv
+/doc/_build/
+/doc/source/
+**/web/upload/
+**/config.ini
+
+#backup files
+.bkp

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+-   repo: local
+    hooks:
+    -   id: update-version
+        name: Update version in __init__.py
+        entry: python scripts/update_version.py
+        language: python
+        files: ^pyproject.toml$
+        types: [toml]
+        always_run: true