Initial commit

.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@v3
+
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v3
+        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@v3
+        with:
+          name: ${{ env.RELEASE_FILE }}
+          path: dist/

.github/workflows/qa.yml

@@ -0,0 +1,36 @@
+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@v2
+
+      - name: Set up Python '3,11'
+        uses: actions/setup-python@v3
+        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

.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: Tests
+
+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']
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+
+      - name: Set up Python ${{ matrix.python }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install Dependencies
+        run: |
+          make dev-deps
+
+      - name: Run Tests
+        run: |
+          make pytest
+
+      - name: Coverage
+        if: ${{ matrix.python == '3.9' }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          python -m pip install coveralls
+          coveralls --service=github
+

.gitignore

@@ -0,0 +1,20 @@
+build/
+_build/
+*.o
+*.so
+*.a
+*.py[cod]
+*.egg-info
+dist/
+__pycache__
+.DS_Store
+*.deb
+*.dsc
+*.build
+*.changes
+*.orig.*
+packaging/*tar.xz
+library/debian/
+.coverage
+.pytest_cache
+.tox

.stickler.yml

@@ -0,0 +1,5 @@
+---
+linters:
+    flake8:
+        python: 3
+        max-line-length: 160

CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+0.0.1
+-----
+
+* Initial Release

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Pimoroni Ltd.
+
+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.

Makefile

@@ -0,0 +1,60 @@
+LIBRARY_NAME := $(shell hatch project metadata name 2> /dev/null)
+LIBRARY_VERSION := $(shell hatch version 2> /dev/null)
+
+.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 "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 --unstable
+
+uninstall:
+	./uninstall.sh
+
+dev-deps:
+	python3 -m pip install -r requirements-dev.txt
+	sudo apt install dos2unix
+
+check:
+	@bash check.sh
+
+qa:
+	tox -e qa
+
+pytest:
+	tox -e py
+
+nopost:
+	@bash check.sh --nopost
+
+tag:
+	git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}"
+
+build: check
+	@hatch build
+
+clean:
+	-rm -r dist
+
+testdeploy: build
+	twine upload --repository testpypi dist/*
+
+deploy: nopost build
+	twine upload dist/*

README.md

@@ -0,0 +1,15 @@
+# gpiodevice
+
+[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/gpiodevice-python/test.yml?branch=main)](https://github.com/pimoroni/gpiodevice-python/actions/workflows/test.yml)
+[![Coverage Status](https://coveralls.io/repos/github/pimoroni/gpiodevice-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/gpiodevice-python?branch=master)
+[![PyPi Package](https://img.shields.io/pypi/v/gpiodevice.svg)](https://pypi.python.org/pypi/gpiodevice)
+[![Python Versions](https://img.shields.io/pypi/pyversions/gpiodevice.svg)](https://pypi.python.org/pypi/gpiodevice)
+
+A GPIO counterpart to [i2cdevice](https://github.com/pimoroni/i2cdevice-python), generated from [the Pimoroni Python Boilerplate](https://github.com/pimoroni/boilerplate-python).
+
+## What is gpiodevice?
+
+gpiodevice is a simple middleware library intended to make some user-facing aspects of interfacing with Linux's GPIO character device ABI (via gpiod) simpler and friendlier.
+
+gpiodevice is not intended to replace gpiod, but collects some common patterns into a reusable library for GPIO-based Python projects.
+

check.sh

@@ -0,0 +1,87 @@
+#!/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))}'`
+
+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: $1\n";
+			exit 1
+		fi
+		POSITIONAL_ARGS+=("$1")
+		shift
+	esac
+done
+
+inform "Checking $LIBRARY_NAME $LIBRARY_VERSION\n"
+
+inform "Checking for trailing whitespace..."
+grep -IUrn --color "[[:blank:]]$" --exclude-dir=dist --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO
+if [[ $? -eq 0 ]]; then
+    warning "Trailing whitespace found!"
+    exit 1
+else
+    success "No trailing whitespace found."
+fi
+printf "\n"
+
+inform "Checking for DOS line-endings..."
+grep -lIUrn --color $'\r' --exclude-dir=dist --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile
+if [[ $? -eq 0 ]]; then
+    warning "DOS line-endings found!"
+    exit 1
+else
+    success "No DOS line-endings found."
+fi
+printf "\n"
+
+inform "Checking CHANGELOG.md..."
+cat CHANGELOG.md | grep ^${LIBRARY_VERSION} > /dev/null 2>&1
+if [[ $? -eq 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}..."
+git tag -l | grep -E "${LIBRARY_VERSION}$"
+if [[ $? -eq 1 ]]; 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

examples/README.md

@@ -0,0 +1 @@
+# Examples

examples/gpiotool

@@ -0,0 +1,26 @@
+#!/bin/env python3
+import sys
+
+import gpiodevice as gd
+
+action = sys.argv[1]
+
+gd.friendly_errors = True
+
+
+if action == "find_chip_by_pins":
+    chip = gd.find_chip_by_pins(sys.argv[2], ignore_claimed=False)
+    print(chip)
+    sys.exit(0)
+
+if action == "find_chip_by_label":
+    if len(sys.argv) == 4:
+        pins = {}
+        for pin in sys.argv[3].split(","):
+            label, line = pin.split(":")
+            pins[label] = int(line)
+        chip = gd.find_chip_by_label(sys.argv[2], pins=pins)
+    else:
+        chip = gd.find_chip_by_label(sys.argv[2])
+    print(chip)
+    sys.exit(0)