diff --git a/library/.coveragerc b/.coveragerc similarity index 100% rename from library/.coveragerc rename to .coveragerc diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..07620e3 --- /dev/null +++ b/.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/ diff --git a/.github/workflows/qa.yml b/.github/workflows/qa.yml new file mode 100644 index 0000000..ac672a5 --- /dev/null +++ b/.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 diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 213fdea..6f8cff7 100644 --- a/.github/workflows/test.yml +++ b/.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' }} diff --git a/library/CHANGELOG.txt b/CHANGELOG.md similarity index 100% rename from library/CHANGELOG.txt rename to CHANGELOG.md diff --git a/Makefile b/Makefile index 49996eb..34f4a7d 100644 --- a/Makefile +++ b/Makefile @@ -1,68 +1,63 @@ -LIBRARY_VERSION=$(shell cat library/setup.py | grep version | awk -F"'" '{print $$2}') -LIBRARY_NAME=$(shell cat library/setup.py | grep name | 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 , 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.rst 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.rst +check: + @bash check.sh -python-license: library/LICENSE.txt +shellcheck: + shellcheck *.sh -library/README.rst: README.md - pandoc --from=markdown --to=rst -o library/README.rst 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/* diff --git a/README.md b/README.md index 8efee3e..b352077 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,25 @@ # Pimoroni Trackball Breakout -[![Build Status](https://travis-ci.com/pimoroni/trackball-python.svg?branch=master)](https://travis-ci.com/pimoroni/trackball-python) -[![Coverage Status](https://coveralls.io/repos/github/pimoroni/trackball-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/trackball-python?branch=master) +[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/trackball-python/test.yml?branch=main)](https://github.com/pimoroni/trackball-python/actions/workflows/test.yml) +[![Coverage Status](https://coveralls.io/repos/github/pimoroni/trackball-python/badge.svg?branch=main)](https://coveralls.io/github/pimoroni/trackball-python?branch=main) [![PyPi Package](https://img.shields.io/pypi/v/trackball.svg)](https://pypi.python.org/pypi/trackball) [![Python Versions](https://img.shields.io/pypi/pyversions/trackball.svg)](https://pypi.python.org/pypi/trackball) - # Installing Stable library from PyPi: -* Just run `sudo pip install trackball` +If you're familiar with virtual environments and have one set up, just run `python3 -m pip install trackball` + +Otherwise: + +* `git clone https://github.com/pimoroni/trackball-python` +* `cd trackball-python` +* `./install.sh` Latest/development library from GitHub: * `git clone https://github.com/pimoroni/trackball-python` * `cd trackball-python` -* `sudo ./install.sh` +* `./install.sh --unstable` diff --git a/check.sh b/check.sh new file mode 100755 index 0000000..38dfc3a --- /dev/null +++ b/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 diff --git a/examples/colour-control.py b/examples/colour-control.py index 12120a9..0cf929f 100755 --- a/examples/colour-control.py +++ b/examples/colour-control.py @@ -1,9 +1,10 @@ #!/usr/bin/env python -import time +import atexit import colorsys +import time + from trackball import TrackBall -import atexit print("""Trackball: Colour Control @@ -39,7 +40,7 @@ def clear_trackball(): x -= left / 10.0 # Clamp to min of 0 and max of 100 - x %= 100 + x %= 100 y = max(0, min(y, 100)) # Calculate hue and brightness diff --git a/examples/evdev-mouse.py b/examples/evdev-mouse.py index 69cc004..7c68aa4 100755 --- a/examples/evdev-mouse.py +++ b/examples/evdev-mouse.py @@ -1,8 +1,11 @@ #!/usr/bin/env python -import time import math import os -from evdev import UInput, ecodes as e +import time + +from evdev import UInput +from evdev import ecodes as e + from trackball import TrackBall print("""evdev-mouse.py - Use the Trackball as a system mouse. @@ -23,7 +26,7 @@ """) -os.system('modprobe uinput') +os.system("modprobe uinput") trackball = TrackBall(interrupt_pin=4) @@ -38,7 +41,7 @@ ] } -ui = UInput(cap, name='Pimoroni Trackball', bustype=e.BUS_USB) +ui = UInput(cap, name="Pimoroni Trackball", bustype=e.BUS_USB) x = 0 y = 0 diff --git a/examples/mouse.py b/examples/mouse.py index d9be639..c184ca2 100755 --- a/examples/mouse.py +++ b/examples/mouse.py @@ -1,7 +1,8 @@ #!/usr/bin/env python -import time -import os import math +import os +import time + from trackball import TrackBall print("""Trackball: Mouse @@ -16,7 +17,7 @@ trackball.set_rgbw(0, 0, 0, 0) # Check for xte (used to control mouse) -use_xte = os.system('which xte') == 0 +use_xte = os.system("which xte") == 0 if use_xte == 0: raise RuntimeError("xte not found. Did you sudo apt install xautomation?") @@ -33,7 +34,7 @@ x = math.copysign(x**2, x) y = down - up y = math.copysign(y**2, y) - cmd = 'xte "mousermove {} {}"'.format(int(x), int(y)) + cmd = f'xte "mousermove {x:.0f} {y:.0f}"' os.system(cmd) time.sleep(0.0001) diff --git a/examples/rainbow.py b/examples/rainbow.py index 98f65fe..68dcf66 100755 --- a/examples/rainbow.py +++ b/examples/rainbow.py @@ -1,7 +1,8 @@ #!/usr/bin/env python -import time import colorsys +import time + from trackball import TrackBall print("""Trackball: Rainbow diff --git a/examples/read-all.py b/examples/read-all.py index fc042d6..99cadf5 100755 --- a/examples/read-all.py +++ b/examples/read-all.py @@ -1,6 +1,7 @@ #!/usr/bin/env python import time + from trackball import TrackBall print("""Trackball: Read All @@ -15,5 +16,5 @@ while True: up, down, left, right, switch, state = trackball.read() - print("r: {:02d} u: {:02d} d: {:02d} l: {:02d} switch: {:03d} state: {}".format(right, up, down, left, switch, state)) + print(f"r: {right:02d} u: {up:02d} d: {down:02d} l: {left:02d} switch: {switch:03d} state: {state}") time.sleep(0.05) diff --git a/install.sh b/install.sh index e89c776..bb671f2 100755 --- a/install.sh +++ b/install.sh @@ -1,22 +1,374 @@ #!/bin/bash +LIBRARY_NAME=$(grep -m 1 name pyproject.toml | awk -F" = " '{print substr($2,2,length($2)-2)}') +CONFIG_FILE=config.txt +CONFIG_DIR="/boot/firmware" +DATESTAMP=$(date "+%Y-%m-%d-%H-%M-%S") +CONFIG_BACKUP=false +APT_HAS_UPDATED=false +RESOURCES_TOP_DIR="$HOME/Pimoroni" +VENV_BASH_SNIPPET="$RESOURCES_TOP_DIR/auto_venv.sh" +VENV_DIR="$HOME/.virtualenvs/pimoroni" +USAGE="./install.sh (--unstable)" +POSITIONAL_ARGS=() +FORCE=false +UNSTABLE=false +PYTHON="python" +CMD_ERRORS=false -printf "Trackball Python Library: Installer\n\n" -if [ $(id -u) -ne 0 ]; then - printf "Script must be run as root. Try 'sudo ./install.sh'\n" +user_check() { + if [ "$(id -u)" -eq 0 ]; then + fatal "Script should not be run as root. Try './install.sh'\n" + fi +} + +confirm() { + if $FORCE; then + true + else + read -r -p "$1 [y/N] " response < /dev/tty + if [[ $response =~ ^(yes|y|Y)$ ]]; then + true + else + false + fi + fi +} + +success() { + echo -e "$(tput setaf 2)$1$(tput sgr0)" +} + +inform() { + echo -e "$(tput setaf 6)$1$(tput sgr0)" +} + +warning() { + echo -e "$(tput setaf 1)⚠ WARNING:$(tput sgr0) $1" +} + +fatal() { + echo -e "$(tput setaf 1)⚠ FATAL:$(tput sgr0) $1" exit 1 +} + +find_config() { + if [ ! -f "$CONFIG_DIR/$CONFIG_FILE" ]; then + CONFIG_DIR="/boot" + if [ ! -f "$CONFIG_DIR/$CONFIG_FILE" ]; then + fatal "Could not find $CONFIG_FILE!" + fi + else + if [ -f "/boot/$CONFIG_FILE" ] && [ ! -L "/boot/$CONFIG_FILE" ]; then + warning "Oops! It looks like /boot/$CONFIG_FILE is not a link to $CONFIG_DIR/$CONFIG_FILE" + warning "You might want to fix this!" + fi + fi + inform "Using $CONFIG_FILE in $CONFIG_DIR" +} + +venv_bash_snippet() { + inform "Checking for $VENV_BASH_SNIPPET\n" + if [ ! -f "$VENV_BASH_SNIPPET" ]; then + inform "Creating $VENV_BASH_SNIPPET\n" + mkdir -p "$RESOURCES_TOP_DIR" + cat << EOF > "$VENV_BASH_SNIPPET" +# Add "source $VENV_BASH_SNIPPET" to your ~/.bashrc to activate +# the Pimoroni virtual environment automagically! +VENV_DIR="$VENV_DIR" +if [ ! -f \$VENV_DIR/bin/activate ]; then + printf "Creating user Python environment in \$VENV_DIR, please wait...\n" + mkdir -p \$VENV_DIR + python3 -m venv --system-site-packages \$VENV_DIR +fi +printf " ↓ ↓ ↓ ↓ Hello, we've activated a Python venv for you. To exit, type \"deactivate\".\n" +source \$VENV_DIR/bin/activate +EOF + fi +} + +venv_check() { + PYTHON_BIN=$(which "$PYTHON") + if [[ $VIRTUAL_ENV == "" ]] || [[ $PYTHON_BIN != $VIRTUAL_ENV* ]]; then + printf "This script should be run in a virtual Python environment.\n" + if confirm "Would you like us to create and/or use a default one?"; then + printf "\n" + if [ ! -f "$VENV_DIR/bin/activate" ]; then + inform "Creating a new virtual Python environment in $VENV_DIR, please wait...\n" + mkdir -p "$VENV_DIR" + /usr/bin/python3 -m venv "$VENV_DIR" --system-site-packages + venv_bash_snippet + # shellcheck disable=SC1091 + source "$VENV_DIR/bin/activate" + else + inform "Activating existing virtual Python environment in $VENV_DIR\n" + printf "source \"%s/bin/activate\"\n" "$VENV_DIR" + # shellcheck disable=SC1091 + source "$VENV_DIR/bin/activate" + fi + else + printf "\n" + fatal "Please create and/or activate a virtual Python environment and try again!\n" + fi + fi + printf "\n" +} + +check_for_error() { + if [ $? -ne 0 ]; then + CMD_ERRORS=true + warning "^^^ 😬 previous command did not exit cleanly!" + fi +} + +function do_config_backup { + if [ ! $CONFIG_BACKUP == true ]; then + CONFIG_BACKUP=true + FILENAME="config.preinstall-$LIBRARY_NAME-$DATESTAMP.txt" + inform "Backing up $CONFIG_DIR/$CONFIG_FILE to $CONFIG_DIR/$FILENAME\n" + sudo cp "$CONFIG_DIR/$CONFIG_FILE" "$CONFIG_DIR/$FILENAME" + mkdir -p "$RESOURCES_TOP_DIR/config-backups/" + cp $CONFIG_DIR/$CONFIG_FILE "$RESOURCES_TOP_DIR/config-backups/$FILENAME" + if [ -f "$UNINSTALLER" ]; then + echo "cp $RESOURCES_TOP_DIR/config-backups/$FILENAME $CONFIG_DIR/$CONFIG_FILE" >> "$UNINSTALLER" + fi + fi +} + +function apt_pkg_install { + PACKAGES_NEEDED=() + PACKAGES_IN=("$@") + # Check the list of packages and only run update/install if we need to + for ((i = 0; i < ${#PACKAGES_IN[@]}; i++)); do + PACKAGE="${PACKAGES_IN[$i]}" + if [ "$PACKAGE" == "" ]; then continue; fi + printf "Checking for %s\n" "$PACKAGE" + dpkg -L "$PACKAGE" > /dev/null 2>&1 + if [ "$?" == "1" ]; then + PACKAGES_NEEDED+=("$PACKAGE") + fi + done + PACKAGES="${PACKAGES_NEEDED[*]}" + if ! [ "$PACKAGES" == "" ]; then + printf "\n" + inform "Installing missing packages: $PACKAGES" + if [ ! $APT_HAS_UPDATED ]; then + sudo apt update + APT_HAS_UPDATED=true + fi + sudo apt install -y "$PACKAGES" + check_for_error + if [ -f "$UNINSTALLER" ]; then + echo "apt uninstall -y $PACKAGES" >> "$UNINSTALLER" + fi + fi +} + +function pip_pkg_install { + # A null Keyring prevents pip stalling in the background + PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring $PYTHON -m pip install --upgrade "$@" + check_for_error +} + +while [[ $# -gt 0 ]]; do + K="$1" + case $K in + -u|--unstable) + UNSTABLE=true + shift + ;; + -f|--force) + FORCE=true + shift + ;; + -p|--python) + PYTHON=$2 + shift + shift + ;; + *) + if [[ $1 == -* ]]; then + printf "Unrecognised option: %s\n" "$1"; + printf "Usage: %s\n" "$USAGE"; + exit 1 + fi + POSITIONAL_ARGS+=("$1") + shift + esac +done + +printf "Installing %s...\n\n" "$LIBRARY_NAME" + +user_check +venv_check + +if [ ! -f "$(which "$PYTHON")" ]; then + fatal "Python path %s not found!\n" "$PYTHON" +fi + +PYTHON_VER=$($PYTHON --version) + +inform "Checking Dependencies. Please wait..." + +# Install toml and try to read pyproject.toml into bash variables + +pip_pkg_install toml + +CONFIG_VARS=$( + $PYTHON - < "$UNINSTALLER" +printf "It's recommended you run these steps manually.\n" +printf "If you want to run the full script, open it in\n" +printf "an editor and remove 'exit 1' from below.\n" +exit 1 +source $VIRTUAL_ENV/bin/activate +EOF + +printf "\n" + +inform "Installing for $PYTHON_VER...\n" -printf "Done!\n" +# Install apt packages from pyproject.toml / tool.pimoroni.apt_packages +apt_pkg_install "${APT_PACKAGES[@]}" + +printf "\n" + +if $UNSTABLE; then + warning "Installing unstable library from source.\n" + pip_pkg_install . +else + inform "Installing stable library from pypi.\n" + pip_pkg_install "$LIBRARY_NAME" +fi + +# shellcheck disable=SC2181 # One of two commands run, depending on --unstable flag +if [ $? -eq 0 ]; then + success "Done!\n" + echo "$PYTHON -m pip uninstall $LIBRARY_NAME" >> "$UNINSTALLER" +fi + +find_config + +printf "\n" + +# Run the setup commands from pyproject.toml / tool.pimoroni.commands + +inform "Running setup commands...\n" +for ((i = 0; i < ${#SETUP_CMDS[@]}; i++)); do + CMD="${SETUP_CMDS[$i]}" + # Attempt to catch anything that touches config.txt and trigger a backup + if [[ "$CMD" == *"raspi-config"* ]] || [[ "$CMD" == *"$CONFIG_DIR/$CONFIG_FILE"* ]] || [[ "$CMD" == *"\$CONFIG_DIR/\$CONFIG_FILE"* ]]; then + do_config_backup + fi + if [[ ! "$CMD" == printf* ]]; then + printf "Running: \"%s\"\n" "$CMD" + fi + eval "$CMD" + check_for_error +done + +printf "\n" + +# Add the config.txt entries from pyproject.toml / tool.pimoroni.configtxt + +for ((i = 0; i < ${#CONFIG_TXT[@]}; i++)); do + CONFIG_LINE="${CONFIG_TXT[$i]}" + if ! [ "$CONFIG_LINE" == "" ]; then + do_config_backup + inform "Adding $CONFIG_LINE to $CONFIG_DIR/$CONFIG_FILE" + sudo sed -i "s/^#$CONFIG_LINE/$CONFIG_LINE/" $CONFIG_DIR/$CONFIG_FILE + if ! grep -q "^$CONFIG_LINE" $CONFIG_DIR/$CONFIG_FILE; then + printf "%s \n" "$CONFIG_LINE" | sudo tee --append $CONFIG_DIR/$CONFIG_FILE + fi + fi +done + +printf "\n" + +# Just a straight copy of the examples/ dir into ~/Pimoroni/board/examples + +if [ -d "examples" ]; then + if confirm "Would you like to copy examples to $RESOURCES_DIR?"; then + inform "Copying examples to $RESOURCES_DIR" + cp -r examples/ "$RESOURCES_DIR" + echo "rm -r $RESOURCES_DIR" >> "$UNINSTALLER" + success "Done!" + fi +fi + +printf "\n" + +# Use pdoc to generate basic documentation from the installed module + +if confirm "Would you like to generate documentation?"; then + inform "Installing pdoc. Please wait..." + pip_pkg_install pdoc + inform "Generating documentation.\n" + if $PYTHON -m pdoc "$LIBRARY_NAME" -o "$RESOURCES_DIR/docs" > /dev/null; then + inform "Documentation saved to $RESOURCES_DIR/docs" + success "Done!" + else + warning "Error: Failed to generate documentation." + fi +fi + +printf "\n" + +if [ "$CMD_ERRORS" = true ]; then + warning "One or more setup commands appear to have failed." + printf "This might prevent things from working properly.\n" + printf "Make sure your OS is up to date and try re-running this installer.\n" + printf "If things still don't work, report this or find help at %s.\n\n" "$GITHUB_URL" +else + success "\nAll done!" +fi + +printf "If this is your first time installing you should reboot for hardware changes to take effect.\n" +printf "Find uninstall steps in %s\n\n" "$UNINSTALLER" + +if [ "$CMD_ERRORS" = true ]; then + exit 1 +else + exit 0 +fi diff --git a/library/LICENSE.txt b/library/LICENSE.txt deleted file mode 100644 index aed751a..0000000 --- a/library/LICENSE.txt +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2018 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. diff --git a/library/MANIFEST.in b/library/MANIFEST.in deleted file mode 100644 index 87505fd..0000000 --- a/library/MANIFEST.in +++ /dev/null @@ -1,5 +0,0 @@ -include CHANGELOG.txt -include LICENSE.txt -include README.rst -include setup.py -recursive-include trackball *.py diff --git a/library/README.rst b/library/README.rst deleted file mode 100644 index b8d9b6d..0000000 --- a/library/README.rst +++ /dev/null @@ -1,26 +0,0 @@ -Pimoroni Trackball Breakout -=========================== - -|Build Status| |Coverage Status| |PyPi Package| |Python Versions| - -Installing -========== - -Stable library from PyPi: - -- Just run ``sudo pip install trackball`` - -Latest/development library from GitHub: - -- ``git clone https://github.com/pimoroni/trackball-python`` -- ``cd trackball-python`` -- ``sudo ./install.sh`` - -.. |Build Status| image:: https://travis-ci.com/pimoroni/trackball-python.svg?branch=master - :target: https://travis-ci.com/pimoroni/trackball-python -.. |Coverage Status| image:: https://coveralls.io/repos/github/pimoroni/trackball-python/badge.svg?branch=master - :target: https://coveralls.io/github/pimoroni/trackball-python?branch=master -.. |PyPi Package| image:: https://img.shields.io/pypi/v/trackball.svg - :target: https://pypi.python.org/pypi/trackball -.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/trackball.svg - :target: https://pypi.python.org/pypi/trackball diff --git a/library/setup.cfg b/library/setup.cfg deleted file mode 100644 index 241587e..0000000 --- a/library/setup.cfg +++ /dev/null @@ -1,10 +0,0 @@ -[flake8] -exclude = - .tox, - .eggs, - .git, - __pycache__, - build, - dist -ignore = - E501 diff --git a/library/setup.py b/library/setup.py deleted file mode 100755 index 9bfb883..0000000 --- a/library/setup.py +++ /dev/null @@ -1,53 +0,0 @@ -#!/usr/bin/env python - -""" -Copyright (c) 2016 Pimoroni - -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. -""" - -try: - from setuptools import setup -except ImportError: - from distutils.core import setup - -classifiers = ['Development Status :: 4 - Beta', - 'Operating System :: POSIX :: Linux', - 'License :: OSI Approved :: MIT License', - 'Intended Audience :: Developers', - 'Programming Language :: Python :: 2.6', - 'Programming Language :: Python :: 2.7', - 'Programming Language :: Python :: 3', - 'Topic :: Software Development', - 'Topic :: System :: Hardware'] - -setup( - name='trackball', - version='0.0.1', - author='Philip Howard', - author_email='phil@pimoroni.com', - description="""Python library for the Pimoroni Trackball breakout""", - long_description=open('README.rst').read() + '\n' + open('CHANGELOG.txt').read(), - license='MIT', - keywords='Raspberry Pi', - url='http://www.pimoroni.com', - classifiers=classifiers, - packages=['trackball'], - install_requires=['smbus2'] -) diff --git a/library/tox.ini b/library/tox.ini deleted file mode 100644 index 21c4d2c..0000000 --- a/library/tox.ini +++ /dev/null @@ -1,21 +0,0 @@ -[tox] -envlist = py{27,35,37,39},qa -skip_missing_interpreters = True - -[testenv] -commands = - python setup.py install - coverage run -m py.test -v -r wsx - coverage report -m -deps = - mock - pytest>=3.1 - pytest-cov - -[testenv:qa] -commands = - flake8 --ignore E501 - rstcheck README.rst -deps = - flake8 - rstcheck diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..0dc3f19 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,119 @@ +[build-system] +requires = ["hatchling", "hatch-fancy-pypi-readme"] +build-backend = "hatchling.build" + +[project] +name = "trackball" +dynamic = ["version", "readme"] +description = "Python library for the Pimoroni Trackball breakout" +license = {file = "LICENSE"} +requires-python = ">= 3.7" +authors = [ + { name = "Philip Howard", email = "phil@pimoroni.com" }, +] +maintainers = [ + { name = "Philip Howard", email = "phil@pimoroni.com" }, +] +keywords = [ + "Pi", + "Raspberry", +] +classifiers = [ + "Development Status :: 4 - Beta", + "Intended Audience :: Developers", + "License :: OSI Approved :: MIT License", + "Operating System :: POSIX :: Linux", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + "Programming Language :: Python :: 3 :: Only", + "Topic :: Software Development", + "Topic :: Software Development :: Libraries", + "Topic :: System :: Hardware", +] +dependencies = [ + "smbus2", + "gpiodevice>=0.0.3" +] + +[project.urls] +GitHub = "https://www.github.com/pimoroni/trackball-python" +Homepage = "https://www.pimoroni.com" + +[tool.hatch.version] +path = "trackball/__init__.py" + +[tool.hatch.build] +include = [ + "trackball", + "README.md", + "CHANGELOG.md", + "LICENSE" +] + +[tool.hatch.build.targets.sdist] +include = [ + "*" +] +exclude = [ + ".*", + "dist" +] + +[tool.hatch.metadata.hooks.fancy-pypi-readme] +content-type = "text/markdown" +fragments = [ + { path = "README.md" }, + { text = "\n" }, + { path = "CHANGELOG.md" } +] + +[tool.ruff] +exclude = [ + '.tox', + '.egg', + '.git', + '__pycache__', + 'build', + 'dist' +] +line-length = 200 + +[tool.codespell] +skip = """ +./.tox,\ +./.egg,\ +./.git,\ +./__pycache__,\ +./build,\ +./dist.\ +""" + +[tool.isort] +line_length = 200 + +[tool.black] +line_length = 200 + +[tool.check-manifest] +ignore = [ + '.stickler.yml', + 'boilerplate.md', + 'check.sh', + 'install.sh', + 'uninstall.sh', + 'Makefile', + 'tox.ini', + 'tests/*', + 'examples/*', + '.coveragerc', + 'requirements-dev.txt' +] + +[tool.pimoroni] +apt_packages = [] +configtxt = [] +commands = [] diff --git a/requirements-dev.txt b/requirements-dev.txt new file mode 100644 index 0000000..525b042 --- /dev/null +++ b/requirements-dev.txt @@ -0,0 +1,9 @@ +check-manifest +ruff +codespell +isort +twine +hatch +hatch-fancy-pypi-readme +tox +pdoc diff --git a/library/tests/conftest.py b/tests/conftest.py similarity index 65% rename from library/tests/conftest.py rename to tests/conftest.py index dc5fd60..afff357 100644 --- a/library/tests/conftest.py +++ b/tests/conftest.py @@ -1,135 +1,134 @@ -import sys -import mock -import pytest - - -CHIP_ID_PRESENT = [0x11, 0xba] -CHIP_ID_INVALID = [0, 0] -chip_id = [0x11, 0xba] -toggle_interrupt = True -interrupt_state = 1 - - -class MockSMBus2(): - def __init__(self, bus): - self.reg = None - self.int = False - - def i2c_rdwr(self, *args): - msg = args[0] - - if type(msg) == I2CMsgWrite: - self.reg = msg.data - - if type(msg) == I2CMsgRead: - if self.reg == [0xFA]: # REG_CHIP_ID_L - msg.set(chip_id) # Return CHIP ID - elif self.reg == [0xF9]: # REG_INT - # Toggle the interrupt pin - # since the code waits for it to be unset and then set again - if toggle_interrupt: - if self.int: - msg.set([0b00000001]) - else: - msg.set([0b00000000]) - self.int = not self.int - else: - msg.set([interrupt_state]) - elif self.reg == [0x04]: # REG_LEFT - # Left, Right, Up, Down, Switch/Switch State - msg.set([1, 0, 1, 0, 0b10000000]) - else: - msg.set([0 for _ in range(msg.length)]) - - -class MockI2CMsg(): - read = None - write = None - - -class I2CMsgWrite(list): - def __init__(self, addr, data): - self.addr = addr - self.data = data - list.__init__(self) - - -class I2CMsgRead(list): - def __init__(self, addr, length): - self.length = length - self.addr = addr - list.__init__(self) - - def set(self, data): - for x in data: - self.append(x) - - -MockI2CMsg.read = I2CMsgRead -MockI2CMsg.write = I2CMsgWrite - - -@pytest.fixture(scope='function', autouse=False) -def smbus2(): - """Mock SMBUS module with fake device.""" - global chip_id - global toggle_interrupt - toggle_interrupt = True - chip_id = CHIP_ID_PRESENT - smbus2 = mock.Mock() - sys.modules['smbus2'] = smbus2 - sys.modules['smbus2'].SMBus = MockSMBus2 - sys.modules['smbus2'].i2c_msg = MockI2CMsg - yield smbus2 - del sys.modules['smbus2'] - - -@pytest.fixture(scope='function', autouse=False, params=[0, 1], ids=["int_low", "int_high"]) -def smbus2_nointerrupt(request): - """Mock SMBUS module with fake device but non-working interrupt.""" - global chip_id - global toggle_interrupt - global interrupt_state - interrupt_state = request.param - toggle_interrupt = False - chip_id = CHIP_ID_PRESENT - smbus2 = mock.Mock() - sys.modules['smbus2'] = smbus2 - sys.modules['smbus2'].SMBus = MockSMBus2 - sys.modules['smbus2'].i2c_msg = MockI2CMsg - yield smbus2 - del sys.modules['smbus2'] - - -@pytest.fixture(scope='function', autouse=False) -def smbus2_devicenotpresent(): - """Mock SMBUS module without fake device.""" - global chip_id - chip_id = CHIP_ID_INVALID - smbus2 = mock.MagicMock() - sys.modules['smbus2'] = smbus2 - sys.modules['smbus2'].SMBus = MockSMBus2 - sys.modules['smbus2'].i2c_msg = MockI2CMsg - yield smbus2 - del sys.modules['smbus2'] - - -@pytest.fixture(scope='function', autouse=False) -def GPIO(): - """Mock RPi.GPIO module.""" - GPIO = mock.MagicMock() - # Fudge for Python < 37 (possibly earlier) - sys.modules['RPi'] = mock.Mock() - sys.modules['RPi'].GPIO = GPIO - sys.modules['RPi.GPIO'] = GPIO - yield GPIO - del sys.modules['RPi'] - del sys.modules['RPi.GPIO'] - - -@pytest.fixture(scope='function', autouse=False) -def trackball(): - """Import and remove trackball module.""" - import trackball - yield trackball - del sys.modules['trackball'] +import sys + +import mock +import pytest + +CHIP_ID_PRESENT = [0x11, 0xBA] +CHIP_ID_INVALID = [0, 0] +chip_id = [0x11, 0xBA] +toggle_interrupt = True +interrupt_state = 1 + + +class MockSMBus2: + def __init__(self, bus): + self.reg = None + self.int = False + + def i2c_rdwr(self, *args): + msg = args[0] + + if type(msg) == I2CMsgWrite: + self.reg = msg.data + + if type(msg) == I2CMsgRead: + if self.reg == [0xFA]: # REG_CHIP_ID_L + msg.set(chip_id) # Return CHIP ID + elif self.reg == [0xF9]: # REG_INT + # Toggle the interrupt pin + # since the code waits for it to be unset and then set again + if toggle_interrupt: + if self.int: + msg.set([0b00000001]) + else: + msg.set([0b00000000]) + self.int = not self.int + else: + msg.set([interrupt_state]) + elif self.reg == [0x04]: # REG_LEFT + # Left, Right, Up, Down, Switch/Switch State + msg.set([1, 0, 1, 0, 0b10000000]) + else: + msg.set([0 for _ in range(msg.length)]) + + +class MockI2CMsg: + read = None + write = None + + +class I2CMsgWrite(list): + def __init__(self, addr, data): + self.addr = addr + self.data = data + list.__init__(self) + + +class I2CMsgRead(list): + def __init__(self, addr, length): + self.length = length + self.addr = addr + list.__init__(self) + + def set(self, data): + for x in data: + self.append(x) + + +MockI2CMsg.read = I2CMsgRead +MockI2CMsg.write = I2CMsgWrite + + +@pytest.fixture(scope="function", autouse=False) +def smbus2(): + """Mock SMBUS module with fake device.""" + global chip_id + global toggle_interrupt + toggle_interrupt = True + chip_id = CHIP_ID_PRESENT + smbus2 = mock.Mock() + sys.modules["smbus2"] = smbus2 + sys.modules["smbus2"].SMBus = MockSMBus2 + sys.modules["smbus2"].i2c_msg = MockI2CMsg + yield smbus2 + del sys.modules["smbus2"] + + +@pytest.fixture(scope="function", autouse=False, params=[0, 1], ids=["int_low", "int_high"]) +def smbus2_nointerrupt(request): + """Mock SMBUS module with fake device but non-working interrupt.""" + global chip_id + global toggle_interrupt + global interrupt_state + interrupt_state = request.param + toggle_interrupt = False + chip_id = CHIP_ID_PRESENT + smbus2 = mock.Mock() + sys.modules["smbus2"] = smbus2 + sys.modules["smbus2"].SMBus = MockSMBus2 + sys.modules["smbus2"].i2c_msg = MockI2CMsg + yield smbus2 + del sys.modules["smbus2"] + + +@pytest.fixture(scope="function", autouse=False) +def smbus2_devicenotpresent(): + """Mock SMBUS module without fake device.""" + global chip_id + chip_id = CHIP_ID_INVALID + smbus2 = mock.MagicMock() + sys.modules["smbus2"] = smbus2 + sys.modules["smbus2"].SMBus = MockSMBus2 + sys.modules["smbus2"].i2c_msg = MockI2CMsg + yield smbus2 + del sys.modules["smbus2"] + + +@pytest.fixture(scope="function", autouse=False) +def GPIO(): + """Mock gpiod and gpiodevice modules.""" + sys.modules['gpiod'] = mock.Mock() + sys.modules['gpiod.line'] = mock.Mock() + sys.modules['gpiodevice'] = mock.MagicMock() + yield + del sys.modules['gpiodevice'] + del sys.modules['gpiod.line'] + del sys.modules['gpiod'] + + +@pytest.fixture(scope="function", autouse=False) +def trackball(): + """Import and remove trackball module.""" + import trackball + yield trackball + del sys.modules["trackball"] diff --git a/library/tests/test_setup.py b/tests/test_setup.py similarity index 84% rename from library/tests/test_setup.py rename to tests/test_setup.py index feb2382..cfb78aa 100644 --- a/library/tests/test_setup.py +++ b/tests/test_setup.py @@ -1,6 +1,7 @@ -import pytest import itertools +import pytest + def test_setup(GPIO, smbus2, trackball): device = trackball.TrackBall() @@ -9,16 +10,16 @@ def test_setup(GPIO, smbus2, trackball): def test_setup_gpio_no_interrupt(GPIO, smbus2, trackball): # Interrupt pin always reads 1 - GPIO.input.return_value = 1 device = trackball.TrackBall(timeout=0.1, interrupt_pin=16) + device._gpio.get_value.return_value = trackball.Value.ACTIVE with pytest.raises(RuntimeError): device.change_address(0x77) def test_setup_gpio_interrupt(GPIO, smbus2, trackball): # Interrupt pin cycles between 0 and 1 - GPIO.input.side_effect = itertools.cycle([0, 1]) device = trackball.TrackBall(timeout=0.1, interrupt_pin=16) + device._gpio.get_value.side_effect = itertools.cycle([trackball.Value.INACTIVE, trackball.Value.ACTIVE]) device.change_address(0x77) @@ -42,10 +43,8 @@ def test_change_address(GPIO, smbus2, trackball): def test_setup_with_interrupt(GPIO, smbus2, trackball): device = trackball.TrackBall(interrupt_pin=16) - GPIO.setwarnings.assert_called_once_with(False) - GPIO.setmode.assert_called_once_with(GPIO.BCM) - GPIO.setup.assert_called_once_with(16, GPIO.IN, pull_up_down=GPIO.PUD_OFF) - del device + assert device._interrupt_pin is not None + assert device._gpio is not None def test_leds(GPIO, smbus2, trackball): diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..44c8654 --- /dev/null +++ b/tox.ini @@ -0,0 +1,34 @@ +[tox] +envlist = py,qa +skip_missing_interpreters = True +isolated_build = true +minversion = 4.0.0 + +[testenv] +commands = + coverage run -m pytest -v -r wsx + coverage report +deps = + mock + pytest>=3.1 + pytest-cov + build + +[testenv:qa] +commands = + check-manifest + python -m build --no-isolation + python -m twine check dist/* + isort --check . + ruff . + codespell . +deps = + check-manifest + ruff + codespell + isort + twine + build + hatch + hatch-fancy-pypi-readme + diff --git a/library/trackball/__init__.py b/trackball/__init__.py similarity index 77% rename from library/trackball/__init__.py rename to trackball/__init__.py index ebbb13e..9afe4aa 100644 --- a/library/trackball/__init__.py +++ b/trackball/__init__.py @@ -1,10 +1,12 @@ -from smbus2 import i2c_msg, SMBus -import time import struct -import RPi.GPIO as GPIO +import time +import gpiod +import gpiodevice +from gpiod.line import Bias, Direction, Value +from smbus2 import SMBus, i2c_msg -__version__ = '0.0.1' +__version__ = "0.0.1" I2C_ADDRESS = 0x0A I2C_ADDRESS_ALTERNATIVE = 0x0B @@ -40,27 +42,30 @@ MSK_CTRL_FWRITE = 0b00001000 -class TrackBall(): +class TrackBall: def __init__(self, address=I2C_ADDRESS, i2c_bus=1, interrupt_pin=None, timeout=5): self._i2c_address = address self._i2c_bus = SMBus(i2c_bus) self._interrupt_pin = interrupt_pin self._timeout = timeout + self._gpio = None chip_id = struct.unpack("