3.0 (#40)

Author: spacemanspiff2007

.github/workflows/publish-dockerhub.yml

@@ -8,31 +8,32 @@ on:
 jobs:
   buildx:
     runs-on: ubuntu-latest
+    environment: dockerhub
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           ref: master
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
         with:
           platforms: all
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
         with:
           version: latest
 
       - name: Login to DockerHub
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           username: ${{ secrets.DOCKER_HUB_USER }}
           password: ${{ secrets.DOCKER_HUB_ACCESS_TOKEN }}
 
       - name: Build and push
         id: docker_build
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v5
         with:
           push: true
           platforms: linux/amd64,linux/arm64,linux/arm/v7,linux/arm/v6

.github/workflows/publish-pypi.yml

@@ -7,13 +7,18 @@ jobs:
   build-n-publish:
     name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
     runs-on: ubuntu-latest
-
+    environment: pypi
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
     steps:
-    - uses: actions/checkout@v3
+
+    - uses: actions/checkout@v4
       with:
         ref: master
+
     - name: Set up Python 3.10
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: '3.10'
 
@@ -27,7 +32,4 @@ jobs:
         python setup.py sdist bdist_wheel
 
     - name: Publish distribution to PyPI
-      uses: pypa/gh-action-pypi-publish@master
-      with:
-        user: __token__
-        password: ${{ secrets.pypi_api_key }}
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/run_tox.yml

@@ -7,8 +7,8 @@ jobs:
     name:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-      - uses: actions/setup-python@v4
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: '3.10'
       - uses: pre-commit/action@v3.0.0
@@ -20,12 +20,12 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: ['3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.10', '3.11', '3.12']
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies

.pre-commit-config.yaml

@@ -6,40 +6,17 @@ repos:
       - id: check-builtin-literals
       - id: check-docstring-first
       - id: check-merge-conflict
-#       - id: check-toml
+      - id: check-toml
       - id: check-yaml
       - id: debug-statements
       - id: end-of-file-fixer
       - id: trailing-whitespace
 
 
-  - repo: https://github.com/pycqa/isort
-    rev: 5.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.3.4
     hooks:
-      - id: isort
-        name: isort (python)
-
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: '6.0.0'
-    hooks:
-    -   id: flake8
-        additional_dependencies:
-          - flake8-bugbear==23.2.13
-          - flake8-comprehensions==3.10.1
-          - flake8-pytest-style==1.6
-#           - flake8-spellcheck==0.28
-#           - flake8-unused-arguments==0.0.12
-          - flake8-noqa==1.3
-          - pep8-naming==0.13.3
-
-
-  - repo: https://github.com/asottile/pyupgrade
-    rev: v3.3.1
-    hooks:
-      - id: pyupgrade
-        args: ["--py38-plus"]
-
+      - id: ruff
 
   - repo: https://github.com/pre-commit/pygrep-hooks
     rev: v1.10.0

.ruff.toml

@@ -0,0 +1,77 @@
+
+line-length = 120
+indent-width = 4
+
+target-version = "py310"
+src = ["src", "test"]
+
+[lint]
+
+# https://docs.astral.sh/ruff/settings/#ignore-init-module-imports
+ignore-init-module-imports = true
+
+select = [
+    "E", "W",   # https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+    "I",        # https://docs.astral.sh/ruff/rules/#isort-i
+    "UP",       # https://docs.astral.sh/ruff/rules/#pyupgrade-up
+
+    "A",        # https://docs.astral.sh/ruff/rules/#flake8-builtins-a
+    "ASYNC",    # https://docs.astral.sh/ruff/rules/#flake8-async-async
+    "C4",       # https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
+    "EM",       # https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
+    "FIX",      # https://docs.astral.sh/ruff/rules/#flake8-fixme-fix
+    "INP",      # https://docs.astral.sh/ruff/rules/#flake8-no-pep420-inp
+    "ISC",      # https://docs.astral.sh/ruff/rules/#flake8-implicit-str-concat-isc
+    "PIE",      # https://docs.astral.sh/ruff/rules/#flake8-pie-pie
+    "PT",       # https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt
+    "PTH",      # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+    "RET",      # https://docs.astral.sh/ruff/rules/#flake8-return-ret
+    "SIM",      # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
+    "SLOT",     # https://docs.astral.sh/ruff/rules/#flake8-slots-slot
+    "T10",      # https://docs.astral.sh/ruff/rules/#flake8-debugger-t10
+    "TCH",      # https://docs.astral.sh/ruff/rules/#flake8-type-checking-tch
+    "TD",       # https://docs.astral.sh/ruff/rules/#flake8-todos-td
+
+    "TRY",      # https://docs.astral.sh/ruff/rules/#tryceratops-try
+    "FLY",      # https://docs.astral.sh/ruff/rules/#flynt-fly
+    "PERF",     # https://docs.astral.sh/ruff/rules/#perflint-perf
+    "RUF",      # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
+
+    # "PL",       # https://docs.astral.sh/ruff/rules/#pylint-pl
+    # "FURB",     # https://docs.astral.sh/ruff/rules/#refurb-furb
+]
+
+ignore = [
+    "RET501",   # https://docs.astral.sh/ruff/rules/unnecessary-return-none/#unnecessary-return-none-ret501
+    "TRY400",   # https://docs.astral.sh/ruff/rules/error-instead-of-exception/
+
+    "A003",     # https://docs.astral.sh/ruff/rules/builtin-attribute-shadowing/
+
+    "UP038",    # https://docs.astral.sh/ruff/rules/non-pep604-isinstance/
+]
+
+
+[format]
+# Use single quotes for non-triple-quoted strings.
+quote-style = "single"
+
+
+
+[lint.flake8-builtins]
+builtins-ignorelist = ["id", "input"]
+
+
+[lint.per-file-ignores]
+"docs/conf.py" = ["INP001", "A001"]
+"setup.py" = ["PTH123"]
+"tests/*" = [
+    "ISC002",   # Implicitly concatenated string literals over multiple lines
+    "E501",     # Line too long
+    "INP001",    # File `FILE_NAME` is part of an implicit namespace package. Add an `__init__.py`
+]
+
+
+
+[lint.isort]
+# https://docs.astral.sh/ruff/settings/#lint_isort_lines-after-imports
+lines-after-imports = 2

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.10-alpine
+FROM python:3.11-alpine
 
 VOLUME /sml2mqtt
 

docs/cli.rst

@@ -0,0 +1,11 @@
+**************************************
+Command Line Interface
+**************************************
+
+.. _COMMAND_LINE_INTERFACE:
+
+.. exec_code::
+    :hide_code:
+
+    import sml2mqtt.__args__
+    sml2mqtt.__args__.get_command_line_args(['-h'])

docs/conf.py

@@ -1,6 +1,8 @@
 import os
 import re
 import sys
+from pathlib import Path
+
 
 RTD_BUILD = os.environ.get('READTHEDOCS') == 'True'
 
@@ -50,7 +52,7 @@
 autoclass_content = 'class'
 
 # so autodoc does find the source
-sys.path.insert(0, os.path.join(os.path.abspath('..'), 'src'))
+sys.path.insert(0, str(Path(__file__).parent.with_name('src')))
 
 
 # -- Options for autodoc pydantic -------------------------------------------------
@@ -86,7 +88,8 @@
 # Don't show warnings for missing python references since these are created via intersphinx during the RTD build
 if not RTD_BUILD:
     nitpick_ignore_regex = [
-        (re.compile(r'^py:class'), re.compile(r'pathlib\..+')),
         (re.compile(r'^py:data'), re.compile(r'typing\..+')),
-        (re.compile(r'^py:class'), re.compile(r'pydantic\..+|.+Constrained(?:Str|Int)Value')),
+        (re.compile(r'^py:class'), re.compile(r'pydantic_core\..+')),
+        # WARNING: py:class reference target not found: sml2mqtt.config.operations.Annotated
+        (re.compile(r'^py:class'), re.compile(r'.+\.Annotated')),
     ]