Skip to content

Commit 44c1e33

Browse files
GadgetoidGadgetoid
authored
Merge pull request #2 from pimoroni/repackage
Bookworm/Pi5 Compatibility: Upgrade to latest boilerplate
2 parents f0539d4 + 9bcd849 commit 44c1e33

28 files changed

+735
-731
lines changed

‎library/.coveragerc ‎.coveragerc

File renamed without changes.

‎.github/workflows/build.yml

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Build
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
test:
11+
name: Python ${{ matrix.python }}
12+
runs-on: ubuntu-latest
13+
strategy:
14+
matrix:
15+
python: ['3.9', '3.10', '3.11']
16+
17+
env:
18+
RELEASE_FILE: ${{ github.event.repository.name }}-${{ github.event.release.tag_name || github.sha }}-py${{ matrix.python }}
19+
20+
steps:
21+
- name: Checkout Code
22+
uses: actions/checkout@v4
23+
24+
- name: Set up Python ${{ matrix.python }}
25+
uses: actions/setup-python@v5
26+
with:
27+
python-version: ${{ matrix.python }}
28+
29+
- name: Install Dependencies
30+
run: |
31+
make dev-deps
32+
33+
- name: Build Packages
34+
run: |
35+
make build
36+
37+
- name: Upload Packages
38+
uses: actions/upload-artifact@v4
39+
with:
40+
name: ${{ env.RELEASE_FILE }}
41+
path: dist/

‎.github/workflows/qa.yml

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
name: QA
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
test:
11+
name: linting & spelling
12+
runs-on: ubuntu-latest
13+
env:
14+
TERM: xterm-256color
15+
16+
steps:
17+
- name: Checkout Code
18+
uses: actions/checkout@v4
19+
20+
- name: Set up Python '3,11'
21+
uses: actions/setup-python@v5
22+
with:
23+
python-version: '3.11'
24+
25+
- name: Install Dependencies
26+
run: |
27+
make dev-deps
28+
29+
- name: Run Quality Assurance
30+
run: |
31+
make qa
32+
33+
- name: Run Code Checks
34+
run: |
35+
make check
36+
37+
- name: Run Bash Code Checks
38+
run: |
39+
make shellcheck

‎.github/workflows/test.yml

+13-9
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Python Tests
1+
name: Tests
22

33
on:
44
pull_request:
@@ -8,30 +8,34 @@ on:
88

99
jobs:
1010
test:
11+
name: Python ${{ matrix.python }}
1112
runs-on: ubuntu-latest
1213
strategy:
1314
matrix:
14-
python: [2.7, 3.6, 3.7, 3.9]
15+
python: ['3.9', '3.10', '3.11']
1516

1617
steps:
17-
- uses: actions/checkout@v2
18+
- name: Checkout Code
19+
uses: actions/checkout@v3
20+
1821
- name: Set up Python ${{ matrix.python }}
19-
uses: actions/setup-python@v2
22+
uses: actions/setup-python@v5
2023
with:
2124
python-version: ${{ matrix.python }}
25+
2226
- name: Install Dependencies
2327
run: |
24-
python -m pip install --upgrade setuptools tox
28+
make dev-deps
29+
2530
- name: Run Tests
26-
working-directory: library
2731
run: |
28-
tox -e py
32+
make pytest
33+
2934
- name: Coverage
35+
if: ${{ matrix.python == '3.9' }}
3036
env:
3137
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
32-
working-directory: library
3338
run: |
3439
python -m pip install coveralls
3540
coveralls --service=github
36-
if: ${{ matrix.python == '3.9' }}
3741

‎library/CHANGELOG.txt ‎CHANGELOG.md

+7-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
3.0.0
2+
-----
3+
4+
* BREAKING: Remove RPi.GPIO and bus autodetect
5+
* BREAKING: Switch to smbus2
6+
17
2.0.0
28
-----
39

@@ -38,7 +44,7 @@
3844
1.2.1
3945
-----
4046

41-
* Removed hard dependancy upon SMbus, added message at runtime
47+
* Removed hard dependency upon SMbus, added message at runtime
4248

4349
1.0.0
4450
-----

‎Makefile

+42-49
Original file line numberDiff line numberDiff line change
@@ -1,70 +1,63 @@
1-
LIBRARY_VERSION=$(shell grep version library/setup.cfg | awk -F" = " '{print $$2}')
2-
LIBRARY_NAME=$(shell grep name library/setup.cfg | awk -F" = " '{print $$2}')
1+
LIBRARY_NAME := $(shell hatch project metadata name 2> /dev/null)
2+
LIBRARY_VERSION := $(shell hatch version 2> /dev/null)
33

4-
.PHONY: usage install uninstall
4+
.PHONY: usage install uninstall check pytest qa build-deps check tag wheel sdist clean dist testdeploy deploy
55
usage:
6+
ifdef LIBRARY_NAME
67
@echo "Library: ${LIBRARY_NAME}"
78
@echo "Version: ${LIBRARY_VERSION}\n"
9+
else
10+
@echo "WARNING: You should 'make dev-deps'\n"
11+
endif
812
@echo "Usage: make <target>, where target is one of:\n"
9-
@echo "install: install the library locally from source"
10-
@echo "uninstall: uninstall the local library"
11-
@echo "check: peform basic integrity checks on the codebase"
12-
@echo "python-readme: generate library/README.md from README.md + library/CHANGELOG.txt"
13-
@echo "python-wheels: build python .whl files for distribution"
14-
@echo "python-sdist: build python source distribution"
15-
@echo "python-clean: clean python build and dist directories"
16-
@echo "python-dist: build all python distribution files"
17-
@echo "python-testdeploy: build all and deploy to test PyPi"
18-
@echo "tag: tag the repository with the current version"
13+
@echo "install: install the library locally from source"
14+
@echo "uninstall: uninstall the local library"
15+
@echo "dev-deps: install Python dev dependencies"
16+
@echo "check: perform basic integrity checks on the codebase"
17+
@echo "qa: run linting and package QA"
18+
@echo "pytest: run Python test fixtures"
19+
@echo "clean: clean Python build and dist directories"
20+
@echo "build: build Python distribution files"
21+
@echo "testdeploy: build and upload to test PyPi"
22+
@echo "deploy: build and upload to PyPi"
23+
@echo "tag: tag the repository with the current version\n"
1924

2025
install:
21-
./install.sh
26+
./install.sh --unstable
2227

2328
uninstall:
2429
./uninstall.sh
2530

26-
check:
27-
@echo "Checking for trailing whitespace"
28-
@! grep -IUrn --color "[[:blank:]]$$" --exclude-dir=sphinx --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO
29-
@echo "Checking for DOS line-endings"
30-
@! grep -lIUrn --color "" --exclude-dir=sphinx --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile
31-
@echo "Checking library/CHANGELOG.txt"
32-
@cat library/CHANGELOG.txt | grep ^${LIBRARY_VERSION}
33-
@echo "Checking library/${LIBRARY_NAME}/__init__.py"
34-
@cat library/${LIBRARY_NAME}/__init__.py | grep "^__version__ = '${LIBRARY_VERSION}'"
35-
36-
tag:
37-
git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
31+
dev-deps:
32+
python3 -m pip install -r requirements-dev.txt
33+
sudo apt install dos2unix shellcheck
3834

39-
python-readme: library/README.md
35+
check:
36+
@bash check.sh
4037

41-
python-license: library/LICENSE.txt
38+
shellcheck:
39+
shellcheck *.sh
4240

43-
library/README.md: README.md library/CHANGELOG.txt
44-
cp README.md library/README.md
45-
printf "\n# Changelog\n" >> library/README.md
46-
cat library/CHANGELOG.txt >> library/README.md
41+
qa:
42+
tox -e qa
4743

48-
library/LICENSE.txt: LICENSE
49-
cp LICENSE library/LICENSE.txt
44+
pytest:
45+
tox -e py
5046

51-
python-wheels: python-readme python-license
52-
cd library; python3 setup.py bdist_wheel
53-
cd library; python setup.py bdist_wheel
47+
nopost:
48+
@bash check.sh --nopost
5449

55-
python-sdist: python-readme python-license
56-
cd library; python setup.py sdist
50+
tag:
51+
git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
5752

58-
python-clean:
59-
-rm -r library/dist
60-
-rm -r library/build
61-
-rm -r library/*.egg-info
53+
build: check
54+
@hatch build
6255

63-
python-dist: python-clean python-wheels python-sdist
64-
ls library/dist
56+
clean:
57+
-rm -r dist
6558

66-
python-testdeploy: python-dist
67-
twine upload --repository-url https://test.pypi.org/legacy/ library/dist/*
59+
testdeploy: build
60+
twine upload --repository testpypi dist/*
6861

69-
python-deploy: check python-dist
70-
twine upload library/dist/*
62+
deploy: nopost build
63+
twine upload dist/*

‎README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# SN3218
22

3-
[![Build Status](https://shields.io/github/workflow/status/pimoroni/sn3218-python/Python%20Tests.svg)](https://github.com/pimoroni/sn3218-python/actions/workflows/test.yml)
4-
[![Coverage Status](https://coveralls.io/repos/github/pimoroni/sn3218-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/sn3218-python?branch=master)
3+
[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/sn3218-python/test.yml?branch=main)](https://github.com/pimoroni/sn3218-python/actions/workflows/test.yml)
4+
[![Coverage Status](https://coveralls.io/repos/github/pimoroni/sn3218-python/badge.svg?branch=main)](https://coveralls.io/github/pimoroni/sn3218-python?branch=main)
55
[![PyPi Package](https://img.shields.io/pypi/v/sn3218.svg)](https://pypi.python.org/pypi/sn3218)
66
[![Python Versions](https://img.shields.io/pypi/pyversions/sn3218.svg)](https://pypi.python.org/pypi/sn3218)
77

@@ -17,13 +17,13 @@ You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configu
1717

1818
Stable library from PyPi:
1919

20-
* Just run `pip3 install sn3218`
20+
* Just run `python3 -m pip install sn3218`
2121

22-
In some cases you may need to use `sudo` or install pip with: `sudo apt install python3-pip`
22+
In most cases you'll need to run this in a virtual Python environment.
2323

2424
Latest/development library from GitHub:
2525

2626
* `git clone https://github.com/pimoroni/sn3218-python`
2727
* `cd sn3218-python`
28-
* `sudo ./install.sh --unstable`
28+
* `./install.sh --unstable`
2929

‎check.sh

+84
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
#!/bin/bash
2+
3+
# This script handles some basic QA checks on the source
4+
5+
NOPOST=$1
6+
LIBRARY_NAME=$(hatch project metadata name)
7+
LIBRARY_VERSION=$(hatch version | awk -F "." '{print $1"."$2"."$3}')
8+
POST_VERSION=$(hatch version | awk -F "." '{print substr($4,0,length($4))}')
9+
TERM=${TERM:="xterm-256color"}
10+
11+
success() {
12+
echo -e "$(tput setaf 2)$1$(tput sgr0)"
13+
}
14+
15+
inform() {
16+
echo -e "$(tput setaf 6)$1$(tput sgr0)"
17+
}
18+
19+
warning() {
20+
echo -e "$(tput setaf 1)$1$(tput sgr0)"
21+
}
22+
23+
while [[ $# -gt 0 ]]; do
24+
K="$1"
25+
case $K in
26+
-p|--nopost)
27+
NOPOST=true
28+
shift
29+
;;
30+
*)
31+
if [[ $1 == -* ]]; then
32+
printf "Unrecognised option: %s\n" "$1";
33+
exit 1
34+
fi
35+
POSITIONAL_ARGS+=("$1")
36+
shift
37+
esac
38+
done
39+
40+
inform "Checking $LIBRARY_NAME $LIBRARY_VERSION\n"
41+
42+
inform "Checking for trailing whitespace..."
43+
if grep -IUrn --color "[[:blank:]]$" --exclude-dir=dist --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO; then
44+
warning "Trailing whitespace found!"
45+
exit 1
46+
else
47+
success "No trailing whitespace found."
48+
fi
49+
printf "\n"
50+
51+
inform "Checking for DOS line-endings..."
52+
if grep -lIUrn --color $'\r' --exclude-dir=dist --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile; then
53+
warning "DOS line-endings found!"
54+
exit 1
55+
else
56+
success "No DOS line-endings found."
57+
fi
58+
printf "\n"
59+
60+
inform "Checking CHANGELOG.md..."
61+
if ! grep "^${LIBRARY_VERSION}" CHANGELOG.md > /dev/null 2>&1; then
62+
warning "Changes missing for version ${LIBRARY_VERSION}! Please update CHANGELOG.md."
63+
exit 1
64+
else
65+
success "Changes found for version ${LIBRARY_VERSION}."
66+
fi
67+
printf "\n"
68+
69+
inform "Checking for git tag ${LIBRARY_VERSION}..."
70+
if ! git tag -l | grep -E "${LIBRARY_VERSION}$"; then
71+
warning "Missing git tag for version ${LIBRARY_VERSION}"
72+
fi
73+
printf "\n"
74+
75+
if [[ $NOPOST ]]; then
76+
inform "Checking for .postN on library version..."
77+
if [[ "$POST_VERSION" != "" ]]; then
78+
warning "Found .$POST_VERSION on library version."
79+
inform "Please only use these for testpypi releases."
80+
exit 1
81+
else
82+
success "OK"
83+
fi
84+
fi

‎examples/blink.py

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
import time
2+
3+
import sn3218
4+
5+
lights = sn3218.SN3218()
6+
lights.enable()
7+
lights.enable_leds(0b111111111111111111)
8+
9+
state = True
10+
11+
while True:
12+
lights.output([state] * 18)
13+
state = not state
14+
time.sleep(1.0)
15+
16+

0 commit comments

Comments
 (0)