Merge branch 'release/2.2.0'

Author: fgmacedo

.github/workflows/codesee-arch-diagram.yml

@@ -15,7 +15,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12"]
 
     steps:
     - uses: actions/checkout@v3
@@ -46,18 +46,11 @@ jobs:
       #              run ruff
       #----------------------------------------------
     - name: Linter with ruff
-      if: matrix.python-version == 3.11
+      if: matrix.python-version == 3.12
       run: |
         source .venv/bin/activate
-        ruff .
-      #----------------------------------------------
-      #              run black
-      #----------------------------------------------
-    - name: Linter with black
-      if: matrix.python-version == 3.11
-      run: |
-        source .venv/bin/activate
-        black . --check --diff
+        ruff check .
+        ruff format --check .
       #----------------------------------------------
       #              run pytest
       #----------------------------------------------
@@ -70,8 +63,8 @@ jobs:
       #          upload coverage
       #----------------------------------------------
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v3
-      if: matrix.python-version == 3.11
+      uses: codecov/codecov-action@v4
+      if: matrix.python-version == 3.12
       with:
         token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
         directory: .

.github/workflows/python-package.yml

@@ -0,0 +1,52 @@
+on:
+  push:
+    tags: [ 'v?*.*.*' ]
+name: release
+
+jobs:
+  pypi-publish:
+    name: upload release to PyPI
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.12"]
+
+        # Specifying a GitHub environment is optional, but strongly encouraged
+    environment: release
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+    steps:
+    - uses: actions/checkout@v3
+    - run: git fetch origin develop
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v4
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Poetry
+      uses: snok/install-poetry@v1
+      with:
+        version: 1.5.1
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+        installer-parallel: true
+    - name: Load cached venv
+      id: cached-poetry-dependencies
+      uses: actions/cache@v3
+      with:
+        path: .venv
+        key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
+    - name: Install dependencies
+      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+      run: poetry install --no-interaction --no-root
+    - name: Test with pytest
+      run: |
+        source .venv/bin/activate
+        pytest
+    - name: Poetry build
+      run: |
+        source .venv/bin/activate
+        poetry build
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/release.yml

@@ -78,3 +78,4 @@ target/
 # Sphinx-galery
 docs/auto_examples/sg_execution_times.*
 docs/auto_examples/*.pickle
+docs/sg_execution_times.rst

.gitignore

@@ -9,13 +9,13 @@ repos:
         exclude: docs/auto_examples
 - repo: https://github.com/charliermarsh/ruff-pre-commit
   # Ruff version.
-  rev: 'v0.0.257'
+  rev: v0.3.7
   hooks:
+    # Run the linter.
     - id: ruff
--   repo: https://github.com/psf/black
-    rev: 22.10.0
-    hooks:
-    -   id: black
+      args: [ --fix ]
+    # Run the formatter.
+    - id: ruff-format
 
 - repo: local
   hooks:

.pre-commit-config.yaml

@@ -7,26 +7,23 @@ version: 2
 
 # Set the version of Python and other tools you might need
 build:
-  os: ubuntu-20.04
+  os: ubuntu-22.04
   tools:
-    python: "3.11"
+    python: "3.12"
   apt_packages:
     - graphviz
   jobs:
     post_create_environment:
       # Install poetry
       # https://python-poetry.org/docs/#installing-manually
-      - pip install poetry
+      - python -m pip install poetry
       # Tell poetry to not use a virtual environment
       - poetry config virtualenvs.create false
+    post_install:
       # Install dependencies with 'docs' dependency group
       # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
-      - poetry install --extras diagrams --with docs
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --extras diagrams --with docs
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
    configuration: docs/conf.py
-
-python:
-   install:
-   - requirements: docs/requirements.txt

.readthedocs.yaml

@@ -66,7 +66,7 @@
 
 # General information about the project.
 project = "Python State Machine"
-copyright = "2023, Fernando Macedo"
+copyright = "2024, Fernando Macedo"
 
 # The version info for the project you're documenting, acts as replacement
 # for |version| and |release|, also used in various other places throughout

docs/conf.py

@@ -87,7 +87,7 @@ A handy shortcut to have the graph representation:
 
 ```py
 >>> machine._graph()
-<pydot.Dot ...
+<pydot.core.Dot ...
 
 ```