Merge branch 'dev'

Author: janiversen

.github/workflows/ci.yml

@@ -18,45 +18,33 @@ on:
 
 jobs:
   linters:
-    name: Linters
-    runs-on: ubuntu-latest
+    name: Linters - ${{ matrix.os.on }} - ${{ matrix.python.version }}
+    runs-on: ${{ matrix.os.on }}
     timeout-minutes: 10
     strategy:
       fail-fast: false
+      matrix:
+        os:
+          - on: ubuntu-latest
+          # - on: macos-latest
+          # - on: windows-latest
+        python:
+          - version: '3.8'
+          - version: '3.9'
+          - version: '3.10'
+          - version: '3.11'
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Set up python
-        uses: actions/setup-python@v4
-        with:
-          python-version: 3.8
-
-      - name: venv restore
-        id: cache-venv
-        uses: syphar/restore-virtualenv@v1
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
-          requirement_files: requirements.txt
-
-      - name: venv create
-        if: steps.cache-venv.outputs.cache-hit != 'true'
-        run: pip install -e . -r requirements.txt
-
-      - name: codespell
-        run: codespell
-
-      - name: pylint
-        run: pylint --recursive=y examples pymodbus test
-
-      - name: precommit (black, bandit, and ruff)
-        run: pre-commit run --all-files
-
-      - name: docs
-        run: make -C doc/ html
-
-      - name: mypy
-        run: mypy pymodbus
-
+          python-version: ${{ matrix.python.version }}
+          cache: 'pip'
+      - run: pip install -e ".[all]"
+      - run: codespell
+      - run: pylint --recursive=y examples pymodbus test
+      - run: pre-commit run --all-files
+      - run: cd doc; ./build_html
+      - run: mypy pymodbus
 
   integreation_test:
     name: pytest - ${{ matrix.os.on }} - ${{ matrix.python.version }}
@@ -75,40 +63,25 @@ jobs:
           - version: '3.10'
           - version: '3.11'
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@v3
-
-      - name: Set up ${{ matrix.python.version }}
-        uses: actions/setup-python@v4
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python.version }}
+          cache: 'pip'
+      - run: pip install -e ".[all]"
 
-      - name: venv restore
-        id: cache-venv
-        uses: syphar/restore-virtualenv@v1
-        with:
-          requirement_files: requirements.txt
-
-      - name: venv create
-        if: steps.cache-venv.outputs.cache-hit != 'true'
-        run: pip install -e . -r requirements.txt
-
-      - name: pytest
-        run: pytest -n0  -v --full-trace --timeout=1200
+      - run: pytest -n0  -v --full-trace --timeout=1200
 
   analyze:
     name: Analyze Python
     runs-on: ubuntu-22.04
 
     steps:
       - uses: actions/checkout@v3
-
       - uses: github/codeql-action/init@v2
         with:
           languages: python
-
       - uses: github/codeql-action/autobuild@v2
-
       - uses: github/codeql-action/analyze@v2
 
   ci_complete:

.github/workflows/clean_workflow_runs.yml

@@ -14,6 +14,9 @@ jobs:
         with:
           token: ${{ github.token }}
           repository: ${{ github.repository }}
+          retain_days: 7
+          keep_minimum_runs: 0
+
 
   clear-cache:
     runs-on: ubuntu-latest

.gitignore

@@ -13,11 +13,6 @@ __pycache__/
 .vscode
 .vscode/
 build/
-/doc/api/epydoc/html/
-/doc/sphinx/doctrees/
-/doc/sphinx/
-/doc/html/
-/doc/_build/
 /dist/
 /pymodbus.egg-info/
 venv

.readthedocs.yml

@@ -1,9 +1,17 @@
-# Build PDF & ePub
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: doc/conf.py
+
+python:
+  install:
+    - requirements: requirements.txt
+
 formats:
     - epub
     - pdf
-requirements_file: requirements.txt
-python:
-    extra_requirements:
-        - documents
-    version: 3.8

API_changes.rst

@@ -1,24 +1,13 @@
-=======================
-PyModbus - API changes.
-=======================
+API changes
+===========
+Versions (X.Y.Z) where Z > 0 e.g. 3.0.1 do NOT have API changes!
 
--------------
-Version 3.6.0 (future)
--------------
+API changes 3.6.0 (future)
+--------------------------
 
--------------
-Version 3.5.2
--------------
-No changes.
 
--------------
-Version 3.5.1
--------------
-No changes.
-
--------------
-Version 3.5.0
--------------
+API changes 3.5.0
+-----------------
 - Remove handler parameter from ModbusUdpServer
 - Remove loop parameter from ModbusSerialServer
 - Remove handler and allow_reuse_port from repl default config
@@ -31,14 +20,9 @@ Version 3.5.0
 - Async clients now accepts `no_resend_on_retry=True`, to not resend the request when retrying.
 - ModbusSerialServer now accepts request_tracer=.
 
--------------
-Version 3.4.1
--------------
-No changes.
 
--------------
-Version 3.4.0
--------------
+API changes 3.4.0
+-----------------
 - Modbus<x>Client .connect() returns True/False (connected or not)
 - Modbue<x>Server handler=, allow_reuse_addr=, backlog= are no longer accepted
 - ModbusTcpClient / AsyncModbusTcpClient no longer support unix path
@@ -48,15 +32,8 @@ Version 3.4.0
 - ModbusSimulatorServer.serve_forever(only_start=False) added to allow return
 
 
--------------
-Version 3.3.1
--------------
-
-No changes.
-
--------------
-Version 3.3.0
--------------
+API changes 3.3.0
+-----------------
 - ModbusTcpDiagClient is removed due to lack of support
 - Clients have an optional parameter: on_reconnect_callback, Function that will be called just before a reconnection attempt.
 - general parameter unit= -> slave=
@@ -65,9 +42,9 @@ Version 3.3.0
 - on_reconnect_callback for async clients works slightly different
 - utilities/unpack_bitstring now expects an argument named `data` not `string`
 
--------------
-Version 3.2.0
--------------
+
+API changes 3.2.0
+-----------------
 - helper to convert values in mixin: convert_from_registers, convert_to_registers
 - import pymodbus.version -> from pymodbus import __version__, __version_full__
 - pymodbus.pymodbus_apply_logging_config(log_file_name="pymodbus.log") to enable file pymodbus_apply_logging_config
@@ -83,23 +60,16 @@ Version 3.2.0
 - client.protocol.<something> --> client.<something>
 - client.factory.<something> --> client.<something>
 
--------------
-Version 3.1.0
--------------
+
+API changes 3.1.0
+-----------------
 - Added --host to client_* examples, to allow easier use.
 - unit= in client calls are no longer converted to slave=, but raises a runtime exception.
 - Added missing client calls (all standard request are not available as methods).
 - client.mask_write_register() changed parameters.
 - server classes no longer accept reuse_port= (the socket do not accept it)
 
----------------------
-Version 3.0.1 / 3.0.2
----------------------
-
-No changes.
-
--------------
-Version 3.0.0
--------------
 
-Base
+API changes 3.0.0
+-----------------
+Base for recording changes.