Release 4.4.0

.github/workflows/ci.yml

@@ -42,9 +42,9 @@ jobs:
         #    python-version: "3.13.0-alpha - 3.13.0"
       fail-fast: false
     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
@@ -139,9 +139,9 @@ jobs:
   docs:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: "3.10"
     - name: Install dependencies
@@ -155,43 +155,41 @@ jobs:
     - name: Run doctest
       run: |
         python -m sphinx -b doctest -W --keep-going doc build
-    - uses: actions/upload-artifact@v3
-      with:
-        name: sphinx-out
-        path: ./build/
-        retention-days: 5
 
   build:
+    name: Packaging
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.10"
       - name: Build wheel and sdist
         run: pipx run build
       - name: Check build artifacts
         run: pipx run twine check --strict dist/*
       - name: Save artifacts
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: python-can-dist
+          name: release
           path: ./dist
 
   upload_pypi:
     needs: [build]
+    name: Release to PyPi
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+      attestations: write
 
     # upload to PyPI only on release
     if: github.event.release && github.event.action == 'published'
     steps:
-      - uses: actions/download-artifact@v3
+      - uses: actions/download-artifact@v4
         with:
-          name: python-can-dist
           path: dist
+          merge-multiple: true
 
-      - uses: pypa/gh-action-pypi-publish@v1.4.2
-        with:
-          user: __token__
-          password: ${{ secrets.PYPI_API_TOKEN }}
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

CHANGELOG.md

@@ -1,3 +1,37 @@
+Version 4.4.0
+=============
+
+Features
+--------
+
+* TRC 1.3 Support: Added support for .trc log files as generated by PCAN Explorer v5 and other tools, expanding compatibility with common log file formats (#1753).
+* ASCReader refactor: improved the ASCReader code (#1717).
+* SYSTEC Interface Enhancements: Added the ability to pass an explicit DLC value to the send() method when using the SYSTEC interface, enhancing flexibility for message definitions (#1756).
+* Socketcand Beacon Detection: Introduced a feature for detecting socketcand beacons, facilitating easier connection and configuration with socketcand servers (#1687).
+* PCAN Driver Echo Frames: Enabled echo frames in the PCAN driver when receive_own_messages is set, improving feedback for message transmissions (#1723).
+* CAN FD Bus Connection for VectorBus: Enabled connecting to CAN FD buses without specifying bus timings, simplifying the connection process for users (#1716).
+* Neousys Configs Detection: Updated the detection mechanism for available Neousys configurations, ensuring more accurate and comprehensive configuration discovery (#1744).
+
+
+Bug Fixes
+---------
+
+* Send Periodic Messages: Fixed an issue where fixed-duration periodic messages were sent one extra time beyond their intended count (#1713).
+* Vector Interface on Windows 11: Addressed compatibility issues with the Vector interface on Windows 11, ensuring stable operation across the latest OS version (#1731).
+* ASCWriter Millisecond Handling: Corrected the handling of milliseconds in ASCWriter, ensuring accurate time representation in log files (#1734).
+* Various minor bug fixes: Addressed several minor bugs to improve overall stability and performance.
+
+Miscellaneous
+-------------
+
+* Invert default value logic for BusABC._is_shutdown. (#1774)
+* Implemented various logging enhancements to provide more detailed and useful operational insights (#1703).
+* Updated CI to use OIDC for connecting GitHub Actions to PyPi, improving security and access control for CI workflows.
+* Fix CI to work for MacOS (#1772).
+* 
+The release also includes various other minor enhancements and bug fixes aimed at improving the reliability and performance of the software.
+
+
 Version 4.3.1
 =============
 

can/__init__.py

@@ -8,7 +8,7 @@
 import logging
 from typing import Any, Dict
 
-__version__ = "4.3.1"
+__version__ = "4.4.0"
 __all__ = [
     "ASCReader",
     "ASCWriter",

doc/development.rst

@@ -117,13 +117,19 @@ Creating a new Release
 - Update ``CONTRIBUTORS.txt`` with any new contributors.
 - For larger changes update ``doc/history.rst``.
 - Sanity check that documentation has stayed inline with code.
-- Create a temporary virtual environment. Run ``python setup.py install`` and ``tox``.
-- Create and upload the distribution: ``python setup.py sdist bdist_wheel``.
-- Sign the packages with gpg ``gpg --detach-sign -a dist/python_can-X.Y.Z-py3-none-any.whl``.
-- Upload with twine ``twine upload dist/python-can-X.Y.Z*``.
 - In a new virtual env check that the package can be installed with pip: ``pip install python-can==X.Y.Z``.
 - Create a new tag in the repository.
 - Check the release on
   `PyPi <https://pypi.org/project/python-can/#history>`__,
   `Read the Docs <https://readthedocs.org/projects/python-can/versions/>`__ and
   `GitHub <https://github.com/hardbyte/python-can/releases>`__.
+
+
+Manual release steps (deprecated)
+---------------------------------
+
+- Create a temporary virtual environment.
+- Build with  ``pipx run build``
+- Create and upload the distribution: ``python setup.py sdist bdist_wheel``.
+- Sign the packages with gpg ``gpg --detach-sign -a dist/python_can-X.Y.Z-py3-none-any.whl``.
+- Upload with twine ``twine upload dist/python-can-X.Y.Z*``.

doc/installation.rst

@@ -131,5 +131,7 @@ reinstall. Download or clone the source repository then:
 
 ::
 
-    python setup.py develop
+    # install in editable mode
+    cd <path-to-this-repo>
+    python3 -m pip install -e .