Bookworm/Pi5 Compatibility: Upgrade to latest boilerplate

.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,36 +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' }}
+

library/CHANGELOG.txt → CHANGELOG.md

@@ -1,3 +1,9 @@
+1.0.0
+-----
+
+* Port to hatch/pyproject.toml
+* Bump to ioexpander >= 1.0.0
+
 0.0.2
 -----
 

Makefile

@@ -1,71 +1,66 @@
-LIBRARY_VERSION=$(shell grep version library/setup.cfg | awk -F" = " '{print $$2}')
-LIBRARY_NAME=$(shell grep name library/setup.cfg | awk -F" = " '{print $$2}')
-PACKAGE_NAME=$(shell grep packages 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 + library/CHANGELOG.txt"
-	@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"
+
+version:
+	@hatch version
 
 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 -IlUrn --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/${PACKAGE_NAME}/__init__.py"
-	@cat library/${PACKAGE_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: version
+	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,19 +1,29 @@
 # MICS6814 Breakout Garden Breakout
 
-[![Build Status](https://shields.io/github/workflow/status/pimoroni/mics6814-python/Python%20Tests)](https://github.com/pimoroni/mics6814-python/actions)
-[![Coverage Status](https://coveralls.io/repos/github/pimoroni/mics6814-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/mics6814-python?branch=master)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/mics6814-python/test.yml?branch=main)](https://github.com/pimoroni/mics6814-python/actions/workflows/test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/pimoroni/mics6814-python/badge.svg?branch=main)](https://coveralls.io/github/pimoroni/mics6814-python?branch=main)
 [![PyPi Package](https://img.shields.io/pypi/v/pimoroni-mics6814.svg)](https://pypi.python.org/pypi/pimoroni-mics6814)
 [![Python Versions](https://img.shields.io/pypi/pyversions/pimoroni-mics6814.svg)](https://pypi.python.org/pypi/pimoroni-mics6814)
 
-# Pre-requisites
+## Installing
+
+### Pre-requisites
 
 You must enable i2c:
 
 * i2c: `sudo raspi-config nonint do_i2c 0`
 
 You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces.
 
-# Installing
+### Full install (recommended):
+
+We've created an easy installation script that will install all pre-requisites and get your BH1745
+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:
+
+![Finding the terminal](http://get.pimoroni.com/resources/github-repo-terminal.png)
+
+In the new terminal window type the command exactly as it appears below (check for typos) and follow the on-screen instructions:
 
 Stable library and dependencies from GitHub:
 
@@ -27,6 +37,12 @@ Latest/development library and dependencies from GitHub:
 * `cd mics6814-python`
 * `sudo ./install.sh --unstable`
 
-Stable (library only) from PyPi:
+**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples:
+
+```
+source ~/.virtualenvs/pimoroni/bin/activate
+```
+
+### Stable (library only) from PyPi:
 
-* Just run `sudo pip3 install pimoroni-mics6814`
+* In your Python Virtual Environment, run `pip install pimoroni-mics6814`

check.sh

@@ -0,0 +1,84 @@
+#!/bin/bash
+
+# This script handles some basic QA checks on the source
+
+NOPOST=$1
+LIBRARY_NAME=$(hatch project metadata name)
+LIBRARY_VERSION=$(hatch version | awk -F "." '{print $1"."$2"."$3}')
+POST_VERSION=$(hatch version | awk -F "." '{print substr($4,0,length($4))}')
+TERM=${TERM:="xterm-256color"}
+
+success() {
+	echo -e "$(tput setaf 2)$1$(tput sgr0)"
+}
+
+inform() {
+	echo -e "$(tput setaf 6)$1$(tput sgr0)"
+}
+
+warning() {
+	echo -e "$(tput setaf 1)$1$(tput sgr0)"
+}
+
+while [[ $# -gt 0 ]]; do
+	K="$1"
+	case $K in
+	-p|--nopost)
+		NOPOST=true
+		shift
+		;;
+	*)
+		if [[ $1 == -* ]]; then
+			printf "Unrecognised option: %s\n" "$1";
+			exit 1
+		fi
+		POSITIONAL_ARGS+=("$1")
+		shift
+	esac
+done
+
+inform "Checking $LIBRARY_NAME $LIBRARY_VERSION\n"
+
+inform "Checking for trailing whitespace..."
+if grep -IUrn --color "[[:blank:]]$" --exclude-dir=dist --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO; then
+    warning "Trailing whitespace found!"
+    exit 1
+else
+    success "No trailing whitespace found."
+fi
+printf "\n"
+
+inform "Checking for DOS line-endings..."
+if grep -lIUrn --color $'\r' --exclude-dir=dist --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile; then
+    warning "DOS line-endings found!"
+    exit 1
+else
+    success "No DOS line-endings found."
+fi
+printf "\n"
+
+inform "Checking CHANGELOG.md..."
+if ! grep "^${LIBRARY_VERSION}" CHANGELOG.md > /dev/null 2>&1; then
+    warning "Changes missing for version ${LIBRARY_VERSION}! Please update CHANGELOG.md."
+    exit 1
+else
+    success "Changes found for version ${LIBRARY_VERSION}."
+fi
+printf "\n"
+
+inform "Checking for git tag ${LIBRARY_VERSION}..."
+if ! git tag -l | grep -E "${LIBRARY_VERSION}$"; then
+    warning "Missing git tag for version ${LIBRARY_VERSION}"
+fi
+printf "\n"
+
+if [[ $NOPOST ]]; then
+    inform "Checking for .postN on library version..."
+    if [[ "$POST_VERSION" != "" ]]; then
+        warning "Found .$POST_VERSION on library version."
+        inform "Please only use these for testpypi releases."
+        exit 1
+    else
+        success "OK"
+    fi
+fi