start

basic information and description

.github/workflows/ci.yml

@@ -0,0 +1,34 @@
+name: Automated quality check
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: [3.7, 3.8, 3.9]
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v1
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install project dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install --upgrade setuptools
+        pip install -r requirements.txt
+        pip install -r tests/requirements_for_tests.txt
+
+    - name: Static code analysis [prospector]
+      run: |
+        prospector --profile tests/prospector_profile.yaml uds
+
+    - name: Unit and integrations tests [pytest]
+      run: |
+        pytest --cov-report term-missing --cov=uds tests

.gitignore

@@ -7,6 +7,7 @@ __pycache__/
 *.so
 
 # Distribution / packaging
+.idea
 .Python
 build/
 develop-eggs/

README.rst

@@ -0,0 +1,21 @@
+*****
+UDS
+*****
+
+.. image:: https://readthedocs.org/projects/uds/badge/?version=latest
+   :target: https://uds.readthedocs.io/
+   :alt: Documentation
+
+Python package for handling Unified Diagnostic Services (UDS) protocol defined by ISO 14229.
+It supports different communication buses on both sides of communication (client and server).
+
+
+Documentation
+=============
+Visit: https://uds.readthedocs.io/en/latest/
+
+
+Contribution
+============
+This project is in early development phase. If you are willing to help with the implementation, please contact with
+the author (Maciej Dąbrowski <[email protected]>)

tests/prospector_profile.yaml

@@ -0,0 +1,48 @@
+# basic prospector settings
+
+strictness: veryhigh
+output-format: grouped
+doc-warnings: true
+autodetect: true
+test-warnings: true
+
+# default tools configuration: http://prospector.landscape.io/en/master/supported_tools.html#defaults
+
+pep8:
+  full: true
+  options:
+    max-line-length: 120
+
+pylint:
+  options:
+    max-line-length: 120
+    max-args: 8
+
+pyflakes:
+  disable:
+    - F401
+
+pep257:
+  disable:
+    - D212
+    - D203
+
+mccabe:
+  run: true
+
+  options:
+    max-complexity: 10
+
+
+# additional tools configuration: http://prospector.landscape.io/en/master/supported_tools.html#optional-extras
+
+mypy:
+  run: true
+  options:
+    ignore-missing-imports: true
+
+vulture:
+  run: true
+
+pyroma:
+  run: true

tests/requirements_for_tests.txt

@@ -0,0 +1,7 @@
+pytest>=6.2.2
+pytest-cov>=2.11.1
+mock>=4.0.2
+prospector==1.3.1
+mypy==0.800
+vulture==2.3
+pyroma==2.6