Merge branch 'develop' into ixxat

Author: hardbyte

.gitattributes

@@ -0,0 +1,2 @@
+.git*      	export-ignore
+.*.yml  	export-ignore

.github/workflows/build.yml

@@ -13,21 +13,21 @@ jobs:
       matrix:
         os: [ubuntu-latest, macos-latest, windows-latest]
         experimental: [false]
-        python-version: ["3.6", "3.7", "3.8", "3.9", "pypy-3.7"]
-        include:
-          # Skipping Py 3.10 on Windows until windows-curses has a cp310 wheel,
-          # see https://github.com/zephyrproject-rtos/windows-curses/issues/26
-          - os: ubuntu-latest
-            experimental: false
-            python-version: "3.10"
-          - os: macos-latest
-            experimental: false
-            python-version: "3.10"
+        python-version: [
+          "3.7",
+          "3.8",
+          "3.9",
+          "3.10",
+          "3.11",
+          "pypy-3.7",
+          "pypy-3.8",
+          "pypy-3.9",
+        ]
       fail-fast: false
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
         python-version: ${{ matrix.python-version }}
     - name: Install dependencies
@@ -38,16 +38,53 @@ jobs:
       run: |
         tox -e gh
     - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1
+      uses: codecov/codecov-action@v3
       with:
         fail_ci_if_error: true
 
+  static-code-analysis:
+    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 -e .
+        pip install -r requirements-lint.txt
+    - name: mypy 3.7
+      run: |
+        mypy --python-version 3.7 .
+    - name: mypy 3.8
+      run: |
+        mypy --python-version 3.8 .
+    - name: mypy 3.9
+      run: |
+        mypy --python-version 3.9 .
+    - name: mypy 3.10
+      run: |
+        mypy --python-version 3.10 .
+    - name: mypy 3.11
+      run: |
+        mypy --python-version 3.11 .
+    - name: pylint
+      run: |
+        pylint --rcfile=.pylintrc \
+        can/**.py \
+        setup.py \
+        doc.conf \
+        scripts/**.py \
+        examples/**.py
+
   format:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Python 3.10
-      uses: actions/setup-python@v2
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v4
       with:
         python-version: "3.10"
     - name: Install dependencies
@@ -57,3 +94,38 @@ jobs:
     - name: Code Format Check with Black
       run: |
         black --check --verbose .
+
+  docs:
+    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 -e .[canalystii,gs_usb]
+        pip install -r doc/doc-requirements.txt
+    - name: Build documentation
+      run: |
+        python -m sphinx -an doc build
+    - uses: actions/upload-artifact@v3
+      with:
+        name: sphinx-out
+        path: ./build/
+        retention-days: 5
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        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/*

.github/workflows/format-code.yml

@@ -9,11 +9,11 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Python
-      uses: actions/setup-python@v2
+      uses: actions/setup-python@v4
       with:
-        python-version: 3.9
+        python-version: "3.10"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
@@ -22,10 +22,7 @@ jobs:
       run: |
         black --verbose .
     - name: Commit Formated Code
-      uses: EndBug/add-and-commit@v5
-      env:
-        # This is necessary in order to push a commit to the repo
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      uses: EndBug/add-and-commit@v9
       with:
         message: "Format code with black"
         # Ref https://git-scm.com/docs/git-add#_examples

.mergify.yml

@@ -18,16 +18,6 @@ pull_request_rules:
       queue:
         name: default
 
-  - name: Request Brian to review changes to the core API
-    conditions:
-      - "-files~=^can/interfaces/$"
-      - "-closed"
-      - "author!=hardbyte"
-    actions:
-      request_reviews:
-        users:
-          - hardbyte
-
   - name: Delete head branch after merge
     conditions:
       - merged

.readthedocs.yml

@@ -0,0 +1,31 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: doc/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+formats:
+  - pdf
+  - epub
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+    - requirements: doc/doc-requirements.txt
+    - method: pip
+      path: .
+      extra_requirements:
+        - canalystii
+        - gs_usb

.travis.yml

@@ -74,23 +74,6 @@ jobs:
         #   -a Write all files
         #   -n nitpicky
         - python -m sphinx -an doc build
-    - stage: linter
-      name: "Linter Checks"
-      python: "3.9"
-      before_install:
-        - travis_retry pip install -r requirements-lint.txt
-      script:
-        # -------------
-        # pylint checking:
-        # check the entire main codebase (except the tests)
-        - pylint --rcfile=.pylintrc can/**.py setup.py doc.conf scripts/**.py examples/**.py
-        # -------------
-        # mypy checking:
-        - mypy
-          can/*.py
-          can/io/**.py
-          scripts/**.py
-          examples/**.py
     - stage: deploy
       name: "PyPi Deployment"
       python: "3.9"