Merge pull request #3 from GiorgioMedico/dev

Refactoring, Documentation and quaternion splines

Author: GiorgioMedico

.github/workflows/docs.yml

@@ -0,0 +1,74 @@
+name: Documentation
+
+on:
+  push:
+    branches: [ main, dev ]
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'interpolatepy/**/*.py'  # Only Python files for API docs
+      - '.github/workflows/docs.yml'
+  pull_request:
+    branches: [ main ]
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'interpolatepy/**/*.py'
+  workflow_dispatch:  # Allow manual triggering
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+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.11'
+        cache: 'pip'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -r requirements-dev.txt
+        pip install -e .
+    
+    - name: Build documentation
+      run: |
+        mkdocs build --clean --strict
+    
+    - name: Setup Pages
+      if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+      uses: actions/configure-pages@v4
+    
+    - name: Upload artifact
+      if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: ./site
+
+  deploy:
+    if: github.ref == 'refs/heads/main' && github.event_name == 'push'
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4
+

.github/workflows/test.yml

@@ -24,9 +24,16 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements-dev.txt
           pip install -e .
-      - name: Testing
+      - name: Testing with coverage
         run: |
-          python -m pytest tests
+          python -m pytest tests --cov=interpolatepy --cov-report=xml --cov-report=term-missing
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false
 
   build-macos:
     runs-on: macos-latest
@@ -44,6 +51,13 @@ jobs:
           python -m pip install --upgrade pip
           pip install -r requirements-dev.txt
           pip install -e .
-      - name: Testing
+      - name: Testing with coverage
         run: |
-          python -m pytest tests
+          python -m pytest tests --cov=interpolatepy --cov-report=xml --cov-report=term-missing
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          file: ./coverage.xml
+          flags: unittests
+          name: codecov-umbrella
+          fail_ci_if_error: false

.gitignore

@@ -19,6 +19,7 @@ data/*.h5
 venv/
 .venv/
 .conda/
+.claude/
 
 ################################
 ########### PYTHON #############
@@ -138,3 +139,5 @@ venv.bak/
 .vscode
 *.code-workspace
 .history
+
+CLAUDE.md

.pre-commit-config.yaml

@@ -8,27 +8,18 @@ repos:
       - id: check-builtin-literals
       - id: check-merge-conflict
       - id: check-yaml
+        exclude: ^mkdocs\.yml$
       - id: check-toml
 
--   repo: https://github.com/PyCQA/isort
-    rev: 6.0.1
-    hooks:
-    -   id: isort
-
--   repo: https://github.com/psf/black
-    rev: 25.1.0
-    hooks:
-    -   id: black
-
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.11.10'
+    rev: 'v0.12.7'
     hooks:
     -   id: ruff
         types_or: [python, pyi, jupyter]
         args: [ --fix, --exit-non-zero-on-fix, --preview ]
 
 -   repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.15.0
+    rev: v1.17.1
     hooks:
     -   id: mypy
         args: [--ignore-missing-imports]