Bump codecov/codecov-action from 3 to 4

.github/dependabot.yml

@@ -1,6 +1,5 @@
 version: 2
 updates:
-
   # Dependencies for GitHub Actions
   - package-ecosystem: "github-actions"
     directory: "/"

.github/release-drafter.yml

@@ -1,47 +1,47 @@
 # .github/release-drafter.yml
 
-name-template: 'v$RESOLVED_VERSION 🌈'
-tag-template: 'v$RESOLVED_VERSION'
+name-template: "v$RESOLVED_VERSION 🌈"
+tag-template: "v$RESOLVED_VERSION"
 filter-by-commitish: true
 commitish: main
 categories:
-  - title: '🚀 New Features'
+  - title: "🚀 New Features"
     labels:
-      - 'feature'
-      - 'new feature'
-      - 'enhancement'
-      - 'customization'
-  - title: '🐛 Bug Fixes'
+      - "feature"
+      - "new feature"
+      - "enhancement"
+      - "customization"
+  - title: "🐛 Bug Fixes"
     labels:
-      - 'fix'
-      - 'bugfix'
-      - 'bug'
-      - 'test'
-      - 'typo'
-      - 'refactor'
-  - title: '📝 Documentation'
+      - "fix"
+      - "bugfix"
+      - "bug"
+      - "test"
+      - "typo"
+      - "refactor"
+  - title: "📝 Documentation"
     labels:
-      - 'documentation'
-      - 'docs'
-      - 'doc'
-  - title: '🤖 Automation'
+      - "documentation"
+      - "docs"
+      - "doc"
+  - title: "🤖 Automation"
     labels:
-      - 'automation'
-      - 'release'
-      - 'workflow'
-version-template: '$MAJOR.$MINOR.$PATCH'
-change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+      - "automation"
+      - "release"
+      - "workflow"
+version-template: "$MAJOR.$MINOR.$PATCH"
+change-template: "- $TITLE @$AUTHOR (#$NUMBER)"
 change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
 version-resolver:
   major:
     labels:
-      - 'major'
+      - "major"
   minor:
     labels:
-      - 'minor'
+      - "minor"
   patch:
     labels:
-      - 'patch'
+      - "patch"
   default: patch
 template: |
   ## Changes

.github/workflows/pages.yml

@@ -1,41 +1,36 @@
-name: docs-test
+name: docs
+
 on:
   push:
     branches:
-    - main
+      - main
     paths:
-    - 'SSI/**'
-    - 'docs/source/**'
-    - '.github/workflows/pages.yml'
+      - "svgdatagrabber/**"
+      - "docs/source/**"
+      - ".github/workflows/pages.yml"
   pull_request:
     branches:
-    - main
+      - main
     paths:
-    - 'SSI/**'
-    - 'docs/source/**'
-    - '.github/workflows/pages.yml'
+      - "svgdatagrabber/**"
+      - "docs/source/**"
+      - ".github/workflows/pages.yml"
   workflow_dispatch:
 
 jobs:
   build:
     runs-on: ubuntu-latest
-    concurrency: pages_staging_environment
-    strategy:
-      matrix:
-        python-version: ['3.10']
     steps:
-    - uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    - uses: actions/checkout@v3
-      with:
-        fetch-depth: 0
-    - name: Installing the library
-      shell: bash -l {0}
-      run: |
-        pip install -r docs/requirements.txt
-        pip install .
-    - name: Build and Commit
-      uses: sphinx-notes/pages@v2
-      with:
-        documentation_path: docs
+      - uses: actions/setup-python@v4
+        with:
+          python-version: "3.12"
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Installing the library
+        run: |
+          pip install -e .[docs]
+      - name: Build and Commit
+        uses: sphinx-notes/pages@v2
+        with:
+          documentation_path: docs

.github/workflows/pypi.yml

@@ -20,19 +20,19 @@ jobs:
   publish:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python
-      uses: actions/setup-python@v4
-      with:
-        python-version: '3.10'
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        pip install build
-    - name: Build package
-      run: python -m build
-    - name: Publish package
-      uses: pypa/[email protected]
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Build package
+        run: python -m build
+      - name: Publish package
+        uses: pypa/[email protected]
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/pytest.yaml

@@ -3,17 +3,17 @@ name: pytest
 on:
   push:
     branches:
-    - main
+      - main
     paths:
-      - 'svgdatagrabber/**'
-      - 'tests/**'
-      - '.github/workflows/pytest.yaml'
+      - "svgdatagrabber/**"
+      - "tests/**"
+      - ".github/workflows/pytest.yaml"
   pull_request:
     types: [opened, reopened, synchronize]
     paths:
-      - 'svgdatagrabber/**'
-      - 'tests/**'
-      - '.github/workflows/pytest.yaml'
+      - "svgdatagrabber/**"
+      - "tests/**"
+      - ".github/workflows/pytest.yaml"
   workflow_dispatch:
 
 jobs:
@@ -22,7 +22,12 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.8", "3.9", "3.10", "3.11"]
+        python-version:
+          - "3.8"
+          - "3.9"
+          - "3.10"
+          - "3.11"
+          - "3.12"
         os: [ubuntu-latest]
     steps:
       - uses: actions/checkout@v3
@@ -33,15 +38,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install flake8 pytest pytest-cov
-          pip install -r requirements.txt
-          pip install -e .
-      - name: Lint with flake8
-        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
+          pip install -e .[dev]
       - name: Test with pytest
         run: |
           pytest
@@ -51,7 +48,7 @@ jobs:
           cond: ${{ github.event_name == 'pull_request' }}
           if_true: ${{ github.base_ref }}
           if_false: ${{ github.ref_name }}
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4
         if: ${{ matrix.python-version == '3.11' }}
         with:
           token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos

.github/workflows/release-drafter.yml

@@ -1,7 +1,7 @@
 name: Release Drafter
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   # pull_request event is required only for autolabeler
   pull_request:
     # Only following types are handled by the action, but one can default to all as well

.pre-commit-config.yaml

@@ -0,0 +1,49 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: "24.2.0"
+    hooks:
+      - id: black
+        args:
+          - --line-length=120
+          - --include='(micromechanical/.*\.pyi?|tests/.*\.py|docs/conf\.py)'
+
+  - repo: https://github.com/pycqa/isort
+    rev: "5.13.2"
+    hooks:
+      - id: isort
+        args:
+          - --profile=black
+      - id: isort
+        name: isort (pyi)
+        types: [pyi]
+        args:
+          - --profile=black
+          - --line-length=120
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: "v0.3.2"
+    hooks:
+      - id: ruff
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v4.5.0"
+    hooks:
+      - id: check-added-large-files
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-yaml
+        args:
+          - --allow-multiple-documents
+      - id: debug-statements
+      - id: name-tests-test
+        args:
+          - --pytest-test-first
+      - id: requirements-txt-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/pre-commit/mirrors-prettier
+    rev: "v3.1.0"
+    hooks:
+      - id: prettier
+        additional_dependencies:
+          - [email protected]

.readthedocs.yml

@@ -8,6 +8,7 @@ sphinx:
 formats: []
 python:
   install:
-    - requirements: docs/requirements.txt
     - method: pip
       path: .
+      extra:
+        - docs

docs/conf.py

@@ -9,41 +9,41 @@
 import os
 import sys
 
-project = 'SvgDataGrabber'
-copyright = '2022, WANG Hailin'
-author = 'WANG Hailin'
+project = "SvgDataGrabber"
+copyright = "2022, WANG Hailin"
+author = "WANG Hailin"
 
 try:
     import svgdatagrabber
 
-    release = version = svgdatagrabber.__version__.split('+')[0]
+    release = version = svgdatagrabber.__version__.split("+")[0]
 except (ImportError, AttributeError):
     import warnings
 
-    warnings.warn('svgdatagrabber is not installed, using 0.0.1')
-    release = version = '0.0.1'
-sys.path.insert(0, os.path.abspath('..'))
+    warnings.warn("svgdatagrabber is not installed, using 0.0.1")
+    release = version = "0.0.1"
+sys.path.insert(0, os.path.abspath(".."))
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'autoapi.extension',
-    'myst_parser',
-    'nbsphinx',
-    'sphinx.ext.autodoc',
-    'sphinx_copybutton',
+    "autoapi.extension",
+    "myst_parser",
+    "nbsphinx",
+    "sphinx.ext.autodoc",
+    "sphinx_copybutton",
 ]
 
 # AutoAPI configuration
-autoapi_dirs = ['../svgdatagrabber']
+autoapi_dirs = ["../svgdatagrabber"]
 
 # Templates
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'furo'
-html_static_path = ['_static']
+html_theme = "furo"
+html_static_path = ["_static"]