Publish SDK

.coveragerc

@@ -0,0 +1,12 @@
+# .coveragerc to control pytest-cov code coverage testing
+
+[run]
+branch = True
+source = src/edgepi
+
+[report]
+show_missing = True
+skip_empty = True
+
+[xml]
+output = test_cov/coverage.xml

.github/workflows/build-and-publish-PyPI.yml

@@ -0,0 +1,33 @@
+# This workflow will build and publish the package to PyPI upon push or merge to main branch
+
+name: Build and Publish to PyPI
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  build-and-publish:
+    name: Build and publish Package to PyPI
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.10'
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements_build.txt ]; then python -m pip install -r requirements_build.txt; fi
+    - name: Build Package
+      run: |
+        python -m build
+    - name: Publish Package to PyPI
+      uses: pypa/gh-action-pypi-publish@v1.5.0
+      with:
+        # TODO: add PyPI user password or access token
+        user: __token__
+        password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/build-and-publish-TestPyPI.yml

@@ -0,0 +1,35 @@
+# This workflow will build and publish the package to TestPyPI upon push or merge to dev branch
+
+name: Build and Publish to TestPyPI
+
+on:
+  push:
+    branches:
+      - 'staging'
+
+jobs:
+  build-and-publish:
+    name: Build and publish Package to TestPyPI
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.10'
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        if [ -f requirements_build.txt ]; then python -m pip install -r requirements_build.txt; fi
+    - name: Bump Patch Number
+      run: |
+        if [ -f bump_patch.py ]; then python bump_patch.py; fi
+    - name: Build Package
+      run: |
+        python -m build
+    - name: Publish Distribution to TestPyPI
+      uses: pypa/gh-action-pypi-publish@master
+      with:
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/

.github/workflows/python-integration-test.yml

@@ -0,0 +1,35 @@
+# This workflow will install Python dependencies, run tests using PyTest.
+
+name: PyTest Integration Test
+
+on:
+  push:
+    branches:
+      - 'staging'
+  pull_request:
+    branches:
+      - 'staging'
+
+jobs:
+  test:
+    name: Self-Hosted Integration Test
+    runs-on: self-hosted
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m venv venv_test
+        source venv_test/bin/activate
+        python -m pip install pytest
+        if [ -f requirements_test.txt ]; then pip install -r requirements_test.txt; fi
+    - name: Test with pytest
+      run: |
+        source venv_test/bin/activate
+        pytest ./src/tests/integration_tests

.github/workflows/python-lint.yml

@@ -0,0 +1,39 @@
+# This workflow will lint all files in repo using PyLint.
+
+name: PyLint
+
+on:
+  push:
+    branches:
+      - 'dev'
+  pull_request:
+    branches:
+      - 'dev'
+
+jobs:
+  lint:
+    name: Linter
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install Dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m venv venv_test
+        source venv_test/bin/activate
+        python -m pip install pylint
+        if [ -f requirements_test.txt ]; then pip install -r requirements_test.txt; fi
+    - name: Analysing the code with pylint
+      run: |
+        source venv_test/bin/activate
+        pylint $(git ls-files '*.py')

.github/workflows/python-unit-test.yml

@@ -0,0 +1,53 @@
+# This workflow will install Python dependencies, run tests using PyTest.
+
+name: PyTest Unit Test
+
+on:
+  push:
+    branches:
+      - 'dev'
+  pull_request:
+    branches:
+      - 'dev'
+
+jobs:
+  test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9"]
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install Dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m venv venv_test
+          source venv_test/bin/activate
+          python -m pip install pytest
+          if [ -f requirements_test.txt ]; then pip install -r requirements_test.txt; fi
+      - name: Test with pytest
+        run: |
+          source venv_test/bin/activate
+          pytest ./src/test_edgepi/unit_tests --cov --cov-report=xml
+      - name: Code Coverage Summary Report
+        uses: irongut/CodeCoverageSummary@v1.2.0
+        with:
+          filename: test_cov/coverage.xml
+          badge: true
+          format: markdown
+          hide_complexity: true
+          indicators: true
+          output: both
+      - name: Add Coverage PR Comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        with:
+          recreate: true
+          path: code-coverage-results.md

.gitignore

@@ -132,3 +132,12 @@ dmypy.json
 
 # Pyre type checker
 .pyre/
+
+#Mac OS env file
+.DS_store
+
+# local test scripts
+src/edgepi/scripts
+
+# hardware test reports
+tests/reports

.pylintrc

@@ -0,0 +1,25 @@
+[MESSAGES CONTROL]
+
+disable=logging-fstring-interpolation,
+        too-many-locals,
+        too-many-arguments,
+        fixme,
+        too-few-public-methods,
+        duplicate-code
+
+[LOGGING]
+
+# Format style used to check logging format string. `old` means using %
+# formatting, while `new` is for `{}` formatting.
+logging-format-style=new
+
+[BASIC]
+# exclude docstring requirement for test and private functions
+no-docstring-rgx=^test_|^_|^fixture
+
+# Good variable names which should always be accepted, separated by a comma
+good-names=fd,ch,dr,tc,i
+
+[REPORTS]
+
+output-format=colorized