Add initial CircuitPython packaging

Author: malcolm-sparkfun

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Build CI
+
+on: [pull_request, push]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Set up Python 3
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.x
+    - name: Versions
+      run: |
+        python3 --version
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+    - name: Fetch correct submodule shas
+      run: git submodule foreach 'git fetch --tags --depth 1 origin $sha1 && git checkout -q $sha1'
+    - name: Install deps
+      run: |
+        sudo apt-get install -y gettext gawk
+        pip install -r requirements.txt
+    - name: Library version
+      run: git describe --dirty --always --tags
+    - name: Build assets
+      run: ./build.sh

.github/workflows/release.yml

@@ -0,0 +1,42 @@
+name: Release Actions
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  upload-release-assets:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Translate Repo Name For Build Tools filename_prefix
+      id: repo-name
+      run: |
+        echo "repo-name=$(
+        echo ${{ github.repository }} |
+        awk -F '\/' '{ print tolower($2) }' |
+        tr '_' '-'
+        )" >> $GITHUB_OUTPUT
+    - name: Set up Python 3
+      uses: actions/setup-python@v4
+      with:
+        python-version: 3.x
+    - name: Versions
+      run: |
+        python3 --version
+    - uses: actions/checkout@v3
+      with:
+        submodules: true
+    - name: Fetch correct submodule shas
+      run: git submodule foreach 'git fetch --tags --depth 1 origin $sha1 && git checkout -q $sha1'
+    - name: Install deps
+      run: |
+        sudo apt-get install -y gettext gawk
+        pip install -r requirements.txt
+    - name: Build assets
+      run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location qwiic/circuitpython --library_depth 2 --package_folder_prefix "Qwiic, qwiic, Pi"
+    - name: Upload Release Assets
+      uses: shogo82148/actions-upload-release-asset@v1
+      with:
+        asset_path: "bundles/*"
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        upload_url: ${{ github.event.release.upload_url }}

.gitmodules

@@ -113,3 +113,6 @@
 	path = qwiic/drivers/qwiic_otos
 	url = https://github.com/sparkfun/Qwiic_OTOS_Py
 
+[submodule "qwiic/circuitpython/Qwiic_SerLCD_Py"]
+	path = qwiic/circuitpython/Qwiic_SerLCD_Py
+	url = [email protected]:sparkfun/Qwiic_SerLCD_Py.git

build.sh

@@ -0,0 +1,38 @@
+#! /bin/bash
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2021 Scott Shawcroft for Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+# This script builds the bundle
+
+set -e
+
+# Below way extracted comma-separated list of package folder prefixes automatically, but it's not working as expected
+# Also we know explicitly what package folder prefixes are used in the our libraries. Keeping this here in case we end up 
+# using it in future. 
+# P=$(
+# ls -RUx |
+# gawk -F '\n' '{ match($1, /(drivers|helpers)\/(.+)\/(.+)\:/, arr) ; if (length(arr[0]) > 0 && match(arr[3], arr[2]) > 0) printf "%s, ", arr[3] }' |
+# gawk '{ trimmed = substr($0, 1, length($0) - 2) ; print "\"" trimmed "\"" }'
+# )
+
+circuitpython-build-bundles --filename_prefix qwiic-py --library_location qwiic/circuitpython --library_depth 2 --package_folder_prefix "Qwiic, qwiic, Pi" 

qwiic/circuitpython/Qwiic_SerLCD_Py

@@ -0,0 +1,2 @@
+circuitpython-build-tools
+setuptools

requirements.txt

@@ -93,7 +93,6 @@
 
         # Specify the Python versions you support here. In particular, ensure
         # that you indicate whether you support Python 2, Python 3 or both.
-        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',

setup.py

@@ -0,0 +1,28 @@
+#! /bin/bash
+
+# The MIT License (MIT)
+#
+# Copyright (c) 2016 Scott Shawcroft for Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+# This script updates all submodules to the latest tag (hopefully release).
+git submodule update
+git submodule foreach git fetch
+git submodule foreach "tag=\$(git rev-list --tags --max-count=1); git checkout -q \$tag"