Bookworm/Pi5 Compatibility: Upgrade to latest boilerplate, port to gpiod

.github/workflows/build.yml

@@ -0,0 +1,41 @@
+name: Build
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Python ${{ matrix.python }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ['3.9', '3.10', '3.11']
+
+    env:
+      RELEASE_FILE: ${{ github.event.repository.name }}-${{ github.event.release.tag_name || github.sha }}-py${{ matrix.python }}
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install Dependencies
+        run: |
+          make dev-deps
+
+      - name: Build Packages
+        run: |
+          make build
+
+      - name: Upload Packages
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.RELEASE_FILE }}
+          path: dist/

.github/workflows/qa.yml

@@ -0,0 +1,39 @@
+name: QA
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: linting & spelling
+    runs-on: ubuntu-latest
+    env:
+      TERM: xterm-256color
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+
+      - name: Set up Python '3,11'
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install Dependencies
+        run: |
+          make dev-deps
+
+      - name: Run Quality Assurance
+        run: |
+          make qa
+
+      - name: Run Code Checks
+        run: |
+          make check
+
+      - name: Run Bash Code Checks
+        run: |
+          make shellcheck

.github/workflows/test.yml

@@ -1,37 +1,41 @@
-name: Python Tests
+name: Tests
 
 on:
   pull_request:
   push:
     branches:
-      - master
+      - main
 
 jobs:
   test:
+    name: Python ${{ matrix.python }}
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python: [2.7, 3.5, 3.7, 3.9]
+        python: ['3.9', '3.10', '3.11']
 
     steps:
-      - uses: actions/checkout@v2
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
       - name: Set up Python ${{ matrix.python }}
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python }}
+
       - name: Install Dependencies
         run: |
-          python -m pip install --upgrade setuptools tox
+          make dev-deps
+
       - name: Run Tests
-        working-directory: library
         run: |
-          tox -e py
+          make pytest
+
       - name: Coverage
+        if: ${{ matrix.python == '3.9' }}
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        working-directory: library
         run: |
           python -m pip install coveralls
           coveralls --service=github
-        if: ${{ matrix.python == '3.9' }}
 

Makefile

@@ -1,70 +1,63 @@
-LIBRARY_VERSION=$(shell grep version library/setup.cfg | awk -F" = " '{print $$2}')
-LIBRARY_NAME=$(shell grep name library/setup.cfg | awk -F" = " '{print $$2}')
+LIBRARY_NAME := $(shell hatch project metadata name 2> /dev/null)
+LIBRARY_VERSION := $(shell hatch version 2> /dev/null)
 
-.PHONY: usage install uninstall
+.PHONY: usage install uninstall check pytest qa build-deps check tag wheel sdist clean dist testdeploy deploy
 usage:
+ifdef LIBRARY_NAME
 	@echo "Library: ${LIBRARY_NAME}"
 	@echo "Version: ${LIBRARY_VERSION}\n"
+else
+	@echo "WARNING: You should 'make dev-deps'\n"
+endif
 	@echo "Usage: make <target>, where target is one of:\n"
-	@echo "install:       install the library locally from source"
-	@echo "uninstall:     uninstall the local library"
-	@echo "check:         peform basic integrity checks on the codebase"
-	@echo "python-readme: generate library/README.md from README.md"
-	@echo "python-wheels: build python .whl files for distribution"
-	@echo "python-sdist:  build python source distribution"
-	@echo "python-clean:  clean python build and dist directories"
-	@echo "python-dist:   build all python distribution files"
-	@echo "python-testdeploy: build all and deploy to test PyPi"
-	@echo "tag:           tag the repository with the current version"
+	@echo "install:      install the library locally from source"
+	@echo "uninstall:    uninstall the local library"
+	@echo "dev-deps:     install Python dev dependencies"
+	@echo "check:        perform basic integrity checks on the codebase"
+	@echo "qa:           run linting and package QA"
+	@echo "pytest:       run Python test fixtures"
+	@echo "clean:        clean Python build and dist directories"
+	@echo "build:        build Python distribution files"
+	@echo "testdeploy:   build and upload to test PyPi"
+	@echo "deploy:       build and upload to PyPi"
+	@echo "tag:          tag the repository with the current version\n"
 
 install:
-	./install.sh
+	./install.sh --unstable
 
 uninstall:
 	./uninstall.sh
 
-check:
-	@echo "Checking for trailing whitespace"
-	@! grep -IUrn --color "[[:blank:]]$$" --exclude-dir=sphinx --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO
-	@echo "Checking for DOS line-endings"
-	@! grep -IUrn --color "" --exclude-dir=sphinx --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile
-	@echo "Checking library/CHANGELOG.txt"
-	@cat library/CHANGELOG.txt | grep ^${LIBRARY_VERSION}
-	@echo "Checking library/${LIBRARY_NAME}/__init__.py"
-	@cat library/${LIBRARY_NAME}/__init__.py | grep "^__version__ = '${LIBRARY_VERSION}'"
-
-tag:
-	git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
+dev-deps:
+	python3 -m pip install -r requirements-dev.txt
+	sudo apt install dos2unix shellcheck
 
-python-readme: library/README.md
+check:
+	@bash check.sh
 
-python-license: library/LICENSE.txt
+shellcheck:
+	shellcheck *.sh
 
-library/README.md: README.md library/CHANGELOG.txt
-	cp README.md library/README.md
-	printf "\n# Changelog\n" >> library/README.md
-	cat library/CHANGELOG.txt >> library/README.md
+qa:
+	tox -e qa
 
-library/LICENSE.txt: LICENSE
-	cp LICENSE library/LICENSE.txt
+pytest:
+	tox -e py
 
-python-wheels: python-readme python-license
-	cd library; python3 setup.py bdist_wheel
-	cd library; python setup.py bdist_wheel
+nopost:
+	@bash check.sh --nopost
 
-python-sdist: python-readme python-license
-	cd library; python setup.py sdist
+tag:
+	git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
 
-python-clean:
-	-rm -r library/dist
-	-rm -r library/build
-	-rm -r library/*.egg-info
+build: check
+	@hatch build
 
-python-dist: python-clean python-wheels python-sdist
-	ls library/dist
+clean:
+	-rm -r dist
 
-python-testdeploy: python-dist
-	twine upload --repository-url https://test.pypi.org/legacy/ library/dist/*
+testdeploy: build
+	twine upload --repository testpypi dist/*
 
-python-deploy: check python-dist
-	twine upload library/dist/*
+deploy: nopost build
+	twine upload dist/*

README.md

@@ -1,7 +1,7 @@
-![Automation HAT](autohat_360.png)
+![Automation HAT](https://github.com/pimoroni/automation-hat/blob/main/autohat_360.png)
 
-[![Build Status](https://travis-ci.com/pimoroni/automation-hat.svg?branch=master)](https://travis-ci.com/pimoroni/automation-hat)
-[![Coverage Status](https://coveralls.io/repos/github/pimoroni/automation-hat/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/automation-hat?branch=master)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/automation-hat/test.yml?branch=main)](https://github.com/pimoroni/automation-hat/actions/workflows/test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/pimoroni/automation-hat/badge.svg?branch=main)](https://coveralls.io/github/pimoroni/automation-hat?branch=main)
 [![PyPi Package](https://img.shields.io/pypi/v/automationhat.svg)](https://pypi.python.org/pypi/automationhat)
 [![Python Versions](https://img.shields.io/pypi/pyversions/automationhat.svg)](https://pypi.python.org/pypi/automationhat)
 
@@ -15,9 +15,9 @@ Automation HAT is a home monitoring and automation controller featuring relays,
 
 ## Installing
 
-### Full install (recommended)
+### Full install (recommended):
 
-We've created an easy installation script that will install all pre-requisites and get your Automation HAT, pHAT or HAT Mini
+We've created an easy installation script that will install all pre-requisites and get your Automation HAT
 up and running with minimal efforts. To run it, fire up Terminal which you'll find in Menu -> Accessories -> Terminal
 on your Raspberry Pi desktop, as illustrated below:
 
@@ -26,61 +26,34 @@ on your Raspberry Pi desktop, as illustrated below:
 In the new terminal window type the command exactly as it appears below (check for typos) and follow the on-screen instructions:
 
 ```bash
-curl https://get.pimoroni.com/automationhat | bash
+git clone https://github.com/pimoroni/automation-hat
+cd automation-hat
+./install.sh
 ```
 
-Alternatively, on Raspbian, you can download the `pimoroni-dashboard` and install your product by browsing to the relevant entry:
+**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:
 
-```bash
-sudo apt-get install pimoroni
-```
-
-(you will find the Dashboard under 'Accessories' too, in the Pi menu - or just run `pimoroni-dashboard` at the command line)
-
-If you choose to download examples you'll find them in `/home/pi/Pimoroni/automationhat/`.
-
-### Manual install
-
-#### Library install for Python 3
-
-on Raspbian:
-
-```bash
-sudo apt-get install python3-automationhat
 ```
-
-other environments:
-
-```bash
-sudo pip3 install automationhat
+source ~/.virtualenvs/pimoroni/bin/activate
 ```
 
-#### Library install for Python 2
+### Development:
 
-on Raspbian:
+If you want to contribute, or like living on the edge of your seat by having the latest code, you can install the development version like so:
 
 ```bash
-sudo apt-get install python-automationhat
+git clone https://github.com/pimoroni/automation-hat
+cd automation-hat
+./install.sh --unstable
 ```
 
-other environments:
+In all cases you will have to enable the I2C bus (and SPI for Automation HAT Mini):
 
-```bash
-sudo pip2 install automationhat
 ```
-
-### Development
-
-If you want to contribute, or like living on the edge of your seat by having the latest code, you should clone this repository, `cd` to the library directory, and run:
-
-```bash
-sudo python3 setup.py install
+sudo raspi-config nonint do_i2c 0
+sudo raspi-config nonint do_spi 0
 ```
 
-(or `sudo python setup.py install` whichever your primary Python environment may be)
-
-In all cases you will have to enable the i2c bus.
-
 ## Documentation & Support
 
 * Guides and tutorials:
@@ -105,3 +78,4 @@ The ADS1015 is a 12-bit ADC, but since the 12th bit is the sign-bit there are on
 Since the full-scale range of the ADC is set to 4.096v, this means that 0-3.3v gives only ~1649 possible usable values making the input measurement granularity somewhere around 0.015v (25.85 / 1649) for the 24v inputs and 0.002v for the 3.3v input.
 
 More information on this topic can be found here: <https://forums.pimoroni.com/t/automation-hat-accuracy/7252/3>
+