From 67bf7f1d81374b319b8de10773f0ebc17b74cf88 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Mon, 15 Jan 2024 14:44:26 +0000 Subject: [PATCH 1/6] Repackage to pyproject/hatch. --- library/.coveragerc => .coveragerc | 1 - .github/workflows/build.yml | 41 +++ .github/workflows/qa.yml | 39 +++ .github/workflows/test.yml | 24 +- .stickler.yml | 5 - library/CHANGELOG.txt => CHANGELOG.md | 0 Makefile | 91 +++--- README.md | 6 +- check.sh | 84 ++++++ {library/drv8830 => drv8830}/__init__.py | 4 +- install-legacy.sh | 256 ----------------- install.sh | 319 +++++++++++++++------- library/LICENSE.txt | 21 -- library/MANIFEST.in | 5 - library/README.md | 25 -- library/setup.cfg | 51 ---- library/setup.py | 36 --- library/tox.ini | 25 -- pyproject.toml | 115 ++++++++ requirements-dev.txt | 9 + {library/tests => tests}/conftest.py | 0 {library/tests => tests}/test_features.py | 0 {library/tests => tests}/test_setup.py | 0 tox.ini | 34 +++ uninstall.sh | 77 +++++- 25 files changed, 666 insertions(+), 602 deletions(-) rename library/.coveragerc => .coveragerc (58%) create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/qa.yml delete mode 100644 .stickler.yml rename library/CHANGELOG.txt => CHANGELOG.md (100%) create mode 100755 check.sh rename {library/drv8830 => drv8830}/__init__.py (99%) delete mode 100755 install-legacy.sh delete mode 100644 library/LICENSE.txt delete mode 100644 library/MANIFEST.in delete mode 100644 library/README.md delete mode 100644 library/setup.cfg delete mode 100755 library/setup.py delete mode 100644 library/tox.ini create mode 100644 pyproject.toml create mode 100644 requirements-dev.txt rename {library/tests => tests}/conftest.py (100%) rename {library/tests => tests}/test_features.py (100%) rename {library/tests => tests}/test_setup.py (100%) create mode 100644 tox.ini diff --git a/library/.coveragerc b/.coveragerc similarity index 58% rename from library/.coveragerc rename to .coveragerc index d3a5543..f3a5cd4 100644 --- a/library/.coveragerc +++ b/.coveragerc @@ -1,4 +1,3 @@ [run] -source = drv8830 omit = .tox/* 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/.stickler.yml b/.stickler.yml deleted file mode 100644 index 2466815..0000000 --- a/.stickler.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -linters: - flake8: - python: 3 - max-line-length: 160 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 a289fed..34f4a7d 100644 --- a/Makefile +++ b/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 , 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" 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/* diff --git a/README.md b/README.md index a1366ca..88242bd 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # DRV8830 Motor Driver Breakout -[![Build Status](https://shields.io/github/workflow/status/pimoroni/drv8830-python/Python%20Tests.svg)](https://github.com/pimoroni/drv8830-python/actions/workflows/test.yml) -[![Coverage Status](https://coveralls.io/repos/github/pimoroni/drv8830-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/drv8830-python?branch=master) +[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/drv8830-python/test.yml?branch=main)](https://github.com/pimoroni/drv8830-python/actions/workflows/test.yml) +[![Coverage Status](https://coveralls.io/repos/github/pimoroni/drv8830-python/badge.svg?branch=main)](https://coveralls.io/github/pimoroni/drv8830-python?branch=main) [![PyPi Package](https://img.shields.io/pypi/v/drv8830.svg)](https://pypi.python.org/pypi/drv8830) [![Python Versions](https://img.shields.io/pypi/pyversions/drv8830.svg)](https://pypi.python.org/pypi/drv8830) @@ -15,5 +15,5 @@ Latest/development library from GitHub: * `git clone https://github.com/pimoroni/drv8830-python` * `cd drv8830-python` -* `sudo ./install.sh --unstable` +* `./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/library/drv8830/__init__.py b/drv8830/__init__.py similarity index 99% rename from library/drv8830/__init__.py rename to drv8830/__init__.py index 09359ec..654b29f 100644 --- a/library/drv8830/__init__.py +++ b/drv8830/__init__.py @@ -65,14 +65,14 @@ def select_i2c_address(self, i2c_addr): def set_outputs(self, out1, out2): """Set the individual driver outputs. - + Possible values are 1 (on) and 0 (off) with the following valid permutations: * 1 1 - brake * 0 0 - coast * 1 0 - forward * 0 1 - reverse - + """ self._drv8830.set('CONTROL', out1=out1, out2=out2) diff --git a/install-legacy.sh b/install-legacy.sh deleted file mode 100755 index 3572e50..0000000 --- a/install-legacy.sh +++ /dev/null @@ -1,256 +0,0 @@ -#!/bin/bash - -CONFIG=/boot/config.txt -DATESTAMP=`date "+%Y-%m-%d-%H-%M-%S"` -CONFIG_BACKUP=false -APT_HAS_UPDATED=false -USER_HOME=/home/$SUDO_USER -RESOURCES_TOP_DIR=$USER_HOME/Pimoroni -WD=`pwd` -USAGE="sudo ./install.sh (--unstable)" -POSITIONAL_ARGS=() -FORCE=false -UNSTABLE=false -CODENAME=`lsb_release -sc` - -if [[ $CODENAME == "bullseye" ]]; then - bash ./install.sh $@ - exit $? -fi - -user_check() { - if [ $(id -u) -ne 0 ]; then - printf "Script must be run as root. Try 'sudo ./install.sh'\n" - exit 1 - 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 -} - -prompt() { - read -r -p "$1 [y/N] " response < /dev/tty - if [[ $response =~ ^(yes|y|Y)$ ]]; then - true - else - false - 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)$1$(tput sgr0)" -} - -function do_config_backup { - if [ ! $CONFIG_BACKUP == true ]; then - CONFIG_BACKUP=true - FILENAME="config.preinstall-$LIBRARY_NAME-$DATESTAMP.txt" - inform "Backing up $CONFIG to /boot/$FILENAME\n" - cp $CONFIG /boot/$FILENAME - mkdir -p $RESOURCES_TOP_DIR/config-backups/ - cp $CONFIG $RESOURCES_TOP_DIR/config-backups/$FILENAME - if [ -f "$UNINSTALLER" ]; then - echo "cp $RESOURCES_TOP_DIR/config-backups/$FILENAME $CONFIG" >> $UNINSTALLER - fi - fi -} - -function apt_pkg_install { - PACKAGES=() - PACKAGES_IN=("$@") - for ((i = 0; i < ${#PACKAGES_IN[@]}; i++)); do - PACKAGE="${PACKAGES_IN[$i]}" - if [ "$PACKAGE" == "" ]; then continue; fi - printf "Checking for $PACKAGE\n" - dpkg -L $PACKAGE > /dev/null 2>&1 - if [ "$?" == "1" ]; then - PACKAGES+=("$PACKAGE") - fi - done - PACKAGES="${PACKAGES[@]}" - if ! [ "$PACKAGES" == "" ]; then - echo "Installing missing packages: $PACKAGES" - if [ ! $APT_HAS_UPDATED ]; then - apt update - APT_HAS_UPDATED=true - fi - apt install -y $PACKAGES - if [ -f "$UNINSTALLER" ]; then - echo "apt uninstall -y $PACKAGES" - fi - fi -} - -while [[ $# -gt 0 ]]; do - K="$1" - case $K in - -u|--unstable) - UNSTABLE=true - shift - ;; - -f|--force) - FORCE=true - shift - ;; - *) - if [[ $1 == -* ]]; then - printf "Unrecognised option: $1\n"; - printf "Usage: $USAGE\n"; - exit 1 - fi - POSITIONAL_ARGS+=("$1") - shift - esac -done - -user_check - -apt_pkg_install python-configparser - -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 -EOF - -printf "$LIBRARY_NAME $LIBRARY_VERSION Python Library: Installer\n\n" - -if $UNSTABLE; then - warning "Installing unstable library from source.\n\n" -else - printf "Installing stable library from pypi.\n\n" -fi - -cd library - -printf "Installing for Python 2..\n" -apt_pkg_install "${PY2_DEPS[@]}" -if $UNSTABLE; then - python setup.py install > /dev/null -else - pip install --upgrade $LIBRARY_NAME -fi -if [ $? -eq 0 ]; then - success "Done!\n" - echo "pip uninstall $LIBRARY_NAME" >> $UNINSTALLER -fi - -if [ -f "/usr/bin/python3" ]; then - printf "Installing for Python 3..\n" - apt_pkg_install "${PY3_DEPS[@]}" - if $UNSTABLE; then - python3 setup.py install > /dev/null - else - pip3 install --upgrade $LIBRARY_NAME - fi - if [ $? -eq 0 ]; then - success "Done!\n" - echo "pip3 uninstall $LIBRARY_NAME" >> $UNINSTALLER - fi -fi - -cd $WD - -for ((i = 0; i < ${#SETUP_CMDS[@]}; i++)); do - CMD="${SETUP_CMDS[$i]}" - # Attempt to catch anything that touches /boot/config.txt and trigger a backup - if [[ "$CMD" == *"raspi-config"* ]] || [[ "$CMD" == *"$CONFIG"* ]] || [[ "$CMD" == *"\$CONFIG"* ]]; then - do_config_backup - fi - eval $CMD -done - -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\n" - sed -i "s/^#$CONFIG_LINE/$CONFIG_LINE/" $CONFIG - if ! grep -q "^$CONFIG_LINE" $CONFIG; then - printf "$CONFIG_LINE\n" >> $CONFIG - fi - fi -done - -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" - -if [ -f "/usr/bin/pydoc" ]; then - printf "Generating documentation.\n" - pydoc -w $LIBRARY_NAME > /dev/null - if [ -f "$LIBRARY_NAME.html" ]; then - cp $LIBRARY_NAME.html $RESOURCES_DIR/docs.html - rm -f $LIBRARY_NAME.html - inform "Documentation saved to $RESOURCES_DIR/docs.html" - success "Done!" - else - warning "Error: Failed to generate documentation." - fi -fi - -success "\nAll done!" -inform "If this is your first time installing you should reboot for hardware changes to take effect.\n" -inform "Find uninstall steps in $UNINSTALLER\n" diff --git a/install.sh b/install.sh index 28d3d46..bb671f2 100755 --- a/install.sh +++ b/install.sh @@ -1,22 +1,24 @@ #!/bin/bash -CONFIG=/boot/config.txt -DATESTAMP=`date "+%Y-%m-%d-%H-%M-%S"` +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 -USER_HOME=/home/$SUDO_USER -RESOURCES_TOP_DIR=$USER_HOME/Pimoroni -WD=`pwd` -USAGE="sudo ./install.sh (--unstable)" +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="/usr/bin/python3" +PYTHON="python" +CMD_ERRORS=false user_check() { - if [ $(id -u) -ne 0 ]; then - printf "Script must be run as root. Try 'sudo ./install.sh'\n" - exit 1 + if [ "$(id -u)" -eq 0 ]; then + fatal "Script should not be run as root. Try './install.sh'\n" fi } @@ -33,15 +35,6 @@ confirm() { fi } -prompt() { - read -r -p "$1 [y/N] " response < /dev/tty - if [[ $response =~ ^(yes|y|Y)$ ]]; then - true - else - false - fi -} - success() { echo -e "$(tput setaf 2)$1$(tput sgr0)" } @@ -51,49 +44,132 @@ inform() { } warning() { - echo -e "$(tput setaf 1)$1$(tput sgr0)" + 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 to /boot/$FILENAME\n" - cp $CONFIG /boot/$FILENAME - mkdir -p $RESOURCES_TOP_DIR/config-backups/ - cp $CONFIG $RESOURCES_TOP_DIR/config-backups/$FILENAME + 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" >> $UNINSTALLER + echo "cp $RESOURCES_TOP_DIR/config-backups/$FILENAME $CONFIG_DIR/$CONFIG_FILE" >> "$UNINSTALLER" fi fi } function apt_pkg_install { - PACKAGES=() + 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 $PACKAGE\n" - dpkg -L $PACKAGE > /dev/null 2>&1 + printf "Checking for %s\n" "$PACKAGE" + dpkg -L "$PACKAGE" > /dev/null 2>&1 if [ "$?" == "1" ]; then - PACKAGES+=("$PACKAGE") + PACKAGES_NEEDED+=("$PACKAGE") fi done - PACKAGES="${PACKAGES[@]}" + PACKAGES="${PACKAGES_NEEDED[*]}" if ! [ "$PACKAGES" == "" ]; then - echo "Installing missing packages: $PACKAGES" + printf "\n" + inform "Installing missing packages: $PACKAGES" if [ ! $APT_HAS_UPDATED ]; then - apt update + sudo apt update APT_HAS_UPDATED=true fi - apt install -y $PACKAGES + sudo apt install -y "$PACKAGES" + check_for_error if [ -f "$UNINSTALLER" ]; then - echo "apt uninstall -y $PACKAGES" + 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 @@ -112,8 +188,8 @@ while [[ $# -gt 0 ]]; do ;; *) if [[ $1 == -* ]]; then - printf "Unrecognised option: $1\n"; - printf "Usage: $USAGE\n"; + printf "Unrecognised option: %s\n" "$1"; + printf "Usage: %s\n" "$USAGE"; exit 1 fi POSITIONAL_ARGS+=("$1") @@ -121,131 +197,178 @@ while [[ $# -gt 0 ]]; do esac done +printf "Installing %s...\n\n" "$LIBRARY_NAME" + user_check +venv_check -if [ ! -f "$PYTHON" ]; then - printf "Python path $PYTHON not found!\n" - exit 1 +if [ ! -f "$(which "$PYTHON")" ]; then + fatal "Python path %s not found!\n" "$PYTHON" fi -PYTHON_VER=`$PYTHON --version` +PYTHON_VER=$($PYTHON --version) -inform "Installing. Please wait..." +inform "Checking Dependencies. Please wait..." -$PYTHON -m pip install --upgrade configparser +# Install toml and try to read pyproject.toml into bash variables -CONFIG_VARS=`$PYTHON - < $UNINSTALLER +# Create a stub uninstaller file, we'll try to add the inverse of every +# install command run to here, though it's not complete. +cat << EOF > "$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 "$LIBRARY_NAME $LIBRARY_VERSION Python Library: Installer\n\n" +printf "\n" -if $UNSTABLE; then - warning "Installing unstable library from source.\n\n" -else - printf "Installing stable library from pypi.\n\n" -fi +inform "Installing for $PYTHON_VER...\n" + +# Install apt packages from pyproject.toml / tool.pimoroni.apt_packages +apt_pkg_install "${APT_PACKAGES[@]}" -cd library +printf "\n" -printf "Installing for $PYTHON_VER...\n" -apt_pkg_install "${PY3_DEPS[@]}" if $UNSTABLE; then - $PYTHON setup.py install > /dev/null + warning "Installing unstable library from source.\n" + pip_pkg_install . else - $PYTHON -m pip install --upgrade $LIBRARY_NAME + 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 + echo "$PYTHON -m pip uninstall $LIBRARY_NAME" >> "$UNINSTALLER" fi -cd $WD +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 /boot/config.txt and trigger a backup - if [[ "$CMD" == *"raspi-config"* ]] || [[ "$CMD" == *"$CONFIG"* ]] || [[ "$CMD" == *"\$CONFIG"* ]]; then + # 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 - eval $CMD + 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\n" - sed -i "s/^#$CONFIG_LINE/$CONFIG_LINE/" $CONFIG - if ! grep -q "^$CONFIG_LINE" $CONFIG; then - printf "$CONFIG_LINE\n" >> $CONFIG + 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 + cp -r examples/ "$RESOURCES_DIR" + echo "rm -r $RESOURCES_DIR" >> "$UNINSTALLER" success "Done!" fi fi printf "\n" -if [ -f "/usr/bin/pydoc" ]; then - printf "Generating documentation.\n" - pydoc -w $LIBRARY_NAME > /dev/null - if [ -f "$LIBRARY_NAME.html" ]; then - cp $LIBRARY_NAME.html $RESOURCES_DIR/docs.html - rm -f $LIBRARY_NAME.html - inform "Documentation saved to $RESOURCES_DIR/docs.html" +# 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 -success "\nAll done!" -inform "If this is your first time installing you should reboot for hardware changes to take effect.\n" -inform "Find uninstall steps in $UNINSTALLER\n" +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 22dd908..0000000 --- a/library/MANIFEST.in +++ /dev/null @@ -1,5 +0,0 @@ -include CHANGELOG.txt -include LICENSE.txt -include README.md -include setup.py -recursive-include drv8830 *.py diff --git a/library/README.md b/library/README.md deleted file mode 100644 index 4ddaa17..0000000 --- a/library/README.md +++ /dev/null @@ -1,25 +0,0 @@ -# DRV8830 Motor Driver Breakout - -[![Build Status](https://shields.io/github/workflow/status/pimoroni/drv8830-python/Python%20Tests.svg)](https://github.com/pimoroni/drv8830-python/actions/workflows/test.yml) -[![Coverage Status](https://coveralls.io/repos/github/pimoroni/drv8830-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/drv8830-python?branch=master) -[![PyPi Package](https://img.shields.io/pypi/v/drv8830.svg)](https://pypi.python.org/pypi/drv8830) -[![Python Versions](https://img.shields.io/pypi/pyversions/drv8830.svg)](https://pypi.python.org/pypi/drv8830) - -# Installing - -Stable library from PyPi: - -* Just run `python3 -m pip install drv8830` - -Latest/development library from GitHub: - -* `git clone https://github.com/pimoroni/drv8830-python` -* `cd drv8830-python` -* `sudo ./install.sh --unstable` - - -# Changelog -0.0.1 ------ - -* Initial Release diff --git a/library/setup.cfg b/library/setup.cfg deleted file mode 100644 index 92fd503..0000000 --- a/library/setup.cfg +++ /dev/null @@ -1,51 +0,0 @@ -# -*- coding: utf-8 -*- -[metadata] -name = drv8830 -version = 0.0.1 -author = Philip Howard -author_email = phil@pimoroni.com -description = Python library for the drv8830 motor driver -long_description = file: README.md -long_description_content_type = text/markdown -keywords = Raspberry Pi -url = https://www.pimoroni.com -project_urls = - GitHub=https://www.github.com/pimoroni/drv8830-python -license = MIT -# This includes the license file(s) in the wheel. -# https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file -license_files = LICENSE.txt -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 :: Software Development :: Libraries - Topic :: System :: Hardware - -[options] -python_requires = >= 2.7 -packages = drv8830 -install_requires = - i2cdevice>=0.0.6 - -[flake8] -exclude = - .tox, - .eggs, - .git, - __pycache__, - build, - dist -ignore = - E501 - -[pimoroni] -py2deps = -py3deps = -configtxt = -commands = diff --git a/library/setup.py b/library/setup.py deleted file mode 100755 index f1fa1b7..0000000 --- a/library/setup.py +++ /dev/null @@ -1,36 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- -""" -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. -""" - -from setuptools import setup, __version__ -from pkg_resources import parse_version - -minimum_version = parse_version('30.4.0') - -if parse_version(__version__) < minimum_version: - raise RuntimeError("Package setuptools must be at least version {}".format(minimum_version)) - -setup( - packages=['drv8830'], - install_requires=['setuptools>={}'.format(minimum_version)] -) diff --git a/library/tox.ini b/library/tox.ini deleted file mode 100644 index 80a285c..0000000 --- a/library/tox.ini +++ /dev/null @@ -1,25 +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 = - i2cdevice - mock - pytest>=3.1 - pytest-cov - -[testenv:qa] -commands = - check-manifest --ignore tox.ini,tests*,.coveragerc - twine check dist/* - flake8 --ignore E501 -deps = - i2cdevice - check-manifest - flake8 - twine diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..ec81771 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,115 @@ +[build-system] +requires = ["hatchling", "hatch-fancy-pypi-readme"] +build-backend = "hatchling.build" + +[project] +name = "drv8830" +dynamic = ["version", "readme"] +description = "Python library for the drv8830 motor driver" +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 = [ + "i2cdevice>=1.0.0" +] + +[project.urls] +GitHub = "https://www.github.com/pimoroni/drv8830-python" +Homepage = "https://www.pimoroni.com" + +[tool.hatch.version] +path = "drv8830/__init__.py" + +[tool.hatch.build] +include = [ + "drv8830", + "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.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 100% rename from library/tests/conftest.py rename to tests/conftest.py diff --git a/library/tests/test_features.py b/tests/test_features.py similarity index 100% rename from library/tests/test_features.py rename to tests/test_features.py diff --git a/library/tests/test_setup.py b/tests/test_setup.py similarity index 100% rename from library/tests/test_setup.py rename to tests/test_setup.py 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/uninstall.sh b/uninstall.sh index 4848039..3314b7f 100755 --- a/uninstall.sh +++ b/uninstall.sh @@ -1,25 +1,72 @@ #!/bin/bash -LIBRARY_VERSION=`cat library/setup.cfg | grep version | awk -F" = " '{print $2}'` -LIBRARY_NAME=`cat library/setup.cfg | grep name | awk -F" = " '{print $2}'` +FORCE=false +LIBRARY_NAME=$(grep -m 1 name pyproject.toml | awk -F" = " '{print substr($2,2,length($2)-2)}') +RESOURCES_DIR=$HOME/Pimoroni/$LIBRARY_NAME +PYTHON="python" -printf "$LIBRARY_NAME $LIBRARY_VERSION Python Library: Uninstaller\n\n" -if [ $(id -u) -ne 0 ]; then - printf "Script must be run as root. Try 'sudo ./uninstall.sh'\n" - exit 1 -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" + exit 1 + fi +} -cd library +user_check() { + if [ "$(id -u)" -eq 0 ]; then + printf "Script should not be run as root. Try './uninstall.sh'\n" + exit 1 + fi +} -printf "Unnstalling for Python 2..\n" -pip uninstall $LIBRARY_NAME +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 +} -if [ -f "/usr/bin/pip3" ]; then - printf "Uninstalling for Python 3..\n" - pip3 uninstall $LIBRARY_NAME -fi +prompt() { + read -r -p "$1 [y/N] " response < /dev/tty + if [[ $response =~ ^(yes|y|Y)$ ]]; then + true + else + false + 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)$1$(tput sgr0)" +} -cd .. +printf "%s Python Library: Uninstaller\n\n" "$LIBRARY_NAME" + +user_check +venv_check + +printf "Uninstalling for Python 3...\n" +$PYTHON -m pip uninstall "$LIBRARY_NAME" + +if [ -d "$RESOURCES_DIR" ]; then + if confirm "Would you like to delete $RESOURCES_DIR?"; then + rm -r "$RESOURCES_DIR" + fi +fi printf "Done!\n" From 414964b339984418a8ee4e3fd9e9b02e7c619b15 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Mon, 15 Jan 2024 14:46:52 +0000 Subject: [PATCH 2/6] QA: Apply isort suggestions. --- drv8830/__init__.py | 3 +-- examples/two-motors.py | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/drv8830/__init__.py b/drv8830/__init__.py index 654b29f..f4e72e4 100644 --- a/drv8830/__init__.py +++ b/drv8830/__init__.py @@ -1,7 +1,6 @@ -from i2cdevice import Device, Register, BitField +from i2cdevice import BitField, Device, Register from i2cdevice.adapter import Adapter, LookupAdapter - __version__ = '0.0.1' I2C_ADDR1 = 0x60 # Default, both select jumpers bridged (not cut) diff --git a/examples/two-motors.py b/examples/two-motors.py index 9562adc..3399786 100644 --- a/examples/two-motors.py +++ b/examples/two-motors.py @@ -1,6 +1,6 @@ import time -from drv8830 import DRV8830, I2C_ADDR1, I2C_ADDR2 +from drv8830 import DRV8830, I2C_ADDR1, I2C_ADDR2 left = DRV8830(I2C_ADDR1) right = DRV8830(I2C_ADDR2) From 9bddfec5fbadecebf01f23882bc9f0ada0f79549 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Mon, 15 Jan 2024 15:03:17 +0000 Subject: [PATCH 3/6] QA: Fix DOS line-endings and whitespace. --- REFERENCE.md | 348 +++++++++++++++++++++++----------------------- tests/conftest.py | 14 +- 2 files changed, 181 insertions(+), 181 deletions(-) diff --git a/REFERENCE.md b/REFERENCE.md index 9d99e48..6fbc5cb 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -1,174 +1,174 @@ -# Reference - -- [Getting Started](#getting-started) - - [Installing](#installing) -- [Examples](#examples) - - [Two Motors](#two-motors) -- [Function Reference](#function-reference) - - [set_voltage](#set_voltage) - - [get_voltage](#get_voltage) - - [set_outputs](#set_outputs) - - [brake](#brake) - - [coast](#coast) - - [forward](#forward) - - [reverse](#reverse) - - [set_direction](#set_direction) - - [get_fault](#get_fault) - - [clear_fault](#get_fault) - - -## Getting Started - -Most people should grab the library from GitHub and run our simple installer: - -### Installing - -``` -git clone https://github.com/pimoroni/drv8830-python -cd drv8830-python -sudo ./install.sh -``` - -This ensures any dependencies are installed and will copy examples into `~/Pimoroni/drv8830/` - -You can install just the drv8830 library by running: - -``` -sudo pip3 install drv8830 -``` - -## Examples - -### Two Motors -[two-motors.py](examples/two-motors.py) - -Demonstrates the use of two DRV8830 drivers as part of a two-wheeled robot. - - -## Function Reference - -In all cases you'll first need to initialise a DRV8830 library instance with the specific I2C address for each driver you're using. - -```python -from drv8830 import DRV8830, I2C_ADDR1 - -drv8830 = DRV8830(i2c_addr=I2C_ADDR1) -``` - -The value that you use for `i2c_addr` will vary depending on your I2C address jumper configuration: - -* `I2C_ADDR1` - `0x60` - both select jumpers bridged (not cut) (default) -* `I2C_ADDR2` - `0x61` - only jumper A0 cut (ADDR+1) -* `I2C_ADDR3` - `0x63` - only jumper A1 cut (ADDR+3) -* `I2C_ADDR4` - `0x64` - both A0 and A1 cut (ADDR+1 and ADDR+3) - -Ensure care when cutting jumpers, use the point of a sharp hobby-knife and avoid slipping since this may damage other traces. - -### set_voltage - -```python -drv8830.set_voltage(voltage) -``` - -Set the motor driver voltage. - -Roughly corresponds to motor speed depending upon the characteristics of your motor. - -Value values range from 0.48v to 5.06v - -### get_voltage - -```python -voltage = drv8830.get_voltage() -``` - -Returns the currently set voltage value from the DRV8830. - -### set_outputs - -```python -drv8830.set_outputs(out1, out2) -``` - -Set the individual driver outputs. Eg: - -```python -drv8830.set_outputs(1, 0) -``` - -Possible values are 1 (on) and 0 (off) with the following valid permutations: - -* 1 1 - brake -* 0 0 - coast -* 1 0 - forward -* 0 1 - reverse - -### brake - -```python -drv8830.brake() -``` - -Drives both outputs high, effectively braking the motor. - -Does the same as `drv8830.set_outputs(1, 1)` or `drv8830.set_direction("brake")`. - -### coast - -```python -drv8830.coast() -``` - -Drives both outputs low, allowing the motor to coast to a stop. - -Does the same as `drv8830.set_outputs(0, 0)` or `drv8830.set_direction("coast")`. - -### forward - -```python -drv8830.forward() -``` - -Drives one output high and the other low, effectively turning the motor "forwards" (albeit this depends on how your motor is positioned and wired) - -Does the same as `drv8830.set_outputs(1, 0)` or `drv8830.set_direction("forward")`. - -### reverse - -```python -drv8830.forward() -``` - -Drives one output high and the other low, effectively turning the motor in "reverse" (albeit this depends on how your motor is positioned and wired) - -Does the same as `drv8830.set_outputs(0, 1)` or `drv8830.set_direction("reverse")`. - -### set_direction - -```python -drv8830.set_direction(direction) -``` - -Accepts a string and sets the direction to the supplied "forward", "backward", "brake" or "coast". - -### get_fault - -```python -fault = drv8830.get_fault() -``` - -Returns a namedtuple of the fault flags: - -* `current_limit` - external current limit exceeded (ilimit resistor), must clear fault or disable motor to reactivate -* `over_temperature` - driver has overheated, device resumes once temperature has dropped -* `under_voltage` - driver is below operating voltage (brownout), resumes once voltage has stabalised -* `over_current` - over-current protection activated, device disabled, must clear fault to reactivate -* `fault` - one or more fault flags is set - -### clear_fault - -```python -drv8830.clear_fault() -``` - -Clear any outstanding fault conditions. +# Reference + +- [Getting Started](#getting-started) + - [Installing](#installing) +- [Examples](#examples) + - [Two Motors](#two-motors) +- [Function Reference](#function-reference) + - [set_voltage](#set_voltage) + - [get_voltage](#get_voltage) + - [set_outputs](#set_outputs) + - [brake](#brake) + - [coast](#coast) + - [forward](#forward) + - [reverse](#reverse) + - [set_direction](#set_direction) + - [get_fault](#get_fault) + - [clear_fault](#get_fault) + + +## Getting Started + +Most people should grab the library from GitHub and run our simple installer: + +### Installing + +``` +git clone https://github.com/pimoroni/drv8830-python +cd drv8830-python +sudo ./install.sh +``` + +This ensures any dependencies are installed and will copy examples into `~/Pimoroni/drv8830/` + +You can install just the drv8830 library by running: + +``` +sudo pip3 install drv8830 +``` + +## Examples + +### Two Motors +[two-motors.py](examples/two-motors.py) + +Demonstrates the use of two DRV8830 drivers as part of a two-wheeled robot. + + +## Function Reference + +In all cases you'll first need to initialise a DRV8830 library instance with the specific I2C address for each driver you're using. + +```python +from drv8830 import DRV8830, I2C_ADDR1 + +drv8830 = DRV8830(i2c_addr=I2C_ADDR1) +``` + +The value that you use for `i2c_addr` will vary depending on your I2C address jumper configuration: + +* `I2C_ADDR1` - `0x60` - both select jumpers bridged (not cut) (default) +* `I2C_ADDR2` - `0x61` - only jumper A0 cut (ADDR+1) +* `I2C_ADDR3` - `0x63` - only jumper A1 cut (ADDR+3) +* `I2C_ADDR4` - `0x64` - both A0 and A1 cut (ADDR+1 and ADDR+3) + +Ensure care when cutting jumpers, use the point of a sharp hobby-knife and avoid slipping since this may damage other traces. + +### set_voltage + +```python +drv8830.set_voltage(voltage) +``` + +Set the motor driver voltage. + +Roughly corresponds to motor speed depending upon the characteristics of your motor. + +Value values range from 0.48v to 5.06v + +### get_voltage + +```python +voltage = drv8830.get_voltage() +``` + +Returns the currently set voltage value from the DRV8830. + +### set_outputs + +```python +drv8830.set_outputs(out1, out2) +``` + +Set the individual driver outputs. Eg: + +```python +drv8830.set_outputs(1, 0) +``` + +Possible values are 1 (on) and 0 (off) with the following valid permutations: + +* 1 1 - brake +* 0 0 - coast +* 1 0 - forward +* 0 1 - reverse + +### brake + +```python +drv8830.brake() +``` + +Drives both outputs high, effectively braking the motor. + +Does the same as `drv8830.set_outputs(1, 1)` or `drv8830.set_direction("brake")`. + +### coast + +```python +drv8830.coast() +``` + +Drives both outputs low, allowing the motor to coast to a stop. + +Does the same as `drv8830.set_outputs(0, 0)` or `drv8830.set_direction("coast")`. + +### forward + +```python +drv8830.forward() +``` + +Drives one output high and the other low, effectively turning the motor "forwards" (albeit this depends on how your motor is positioned and wired) + +Does the same as `drv8830.set_outputs(1, 0)` or `drv8830.set_direction("forward")`. + +### reverse + +```python +drv8830.forward() +``` + +Drives one output high and the other low, effectively turning the motor in "reverse" (albeit this depends on how your motor is positioned and wired) + +Does the same as `drv8830.set_outputs(0, 1)` or `drv8830.set_direction("reverse")`. + +### set_direction + +```python +drv8830.set_direction(direction) +``` + +Accepts a string and sets the direction to the supplied "forward", "backward", "brake" or "coast". + +### get_fault + +```python +fault = drv8830.get_fault() +``` + +Returns a namedtuple of the fault flags: + +* `current_limit` - external current limit exceeded (ilimit resistor), must clear fault or disable motor to reactivate +* `over_temperature` - driver has overheated, device resumes once temperature has dropped +* `under_voltage` - driver is below operating voltage (brownout), resumes once voltage has stabalised +* `over_current` - over-current protection activated, device disabled, must clear fault to reactivate +* `fault` - one or more fault flags is set + +### clear_fault + +```python +drv8830.clear_fault() +``` + +Clear any outstanding fault conditions. diff --git a/tests/conftest.py b/tests/conftest.py index 232b761..5c8439f 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,7 +1,7 @@ -import pytest -from i2cdevice import MockSMBus - - -@pytest.fixture(scope='function', autouse=False) -def i2c_dev(): - yield MockSMBus(1) +import pytest +from i2cdevice import MockSMBus + + +@pytest.fixture(scope='function', autouse=False) +def i2c_dev(): + yield MockSMBus(1) From 525805b5555541b4e2be8adf53c21c7db10b1946 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Thu, 16 May 2024 13:35:57 +0100 Subject: [PATCH 4/6] Sync boilerplate. * install.sh: drop quotes around apt packages. * Makefile: fail make tag if dev tools not installed. * tox.ini: update ruff invocation to avoid deprecation warning. * install.sh: drop symlink warning for /boot/config.txt. --- Makefile | 5 ++++- install.sh | 8 ++------ tox.ini | 2 +- 3 files changed, 7 insertions(+), 8 deletions(-) diff --git a/Makefile b/Makefile index 34f4a7d..56cf0df 100644 --- a/Makefile +++ b/Makefile @@ -22,6 +22,9 @@ endif @echo "deploy: build and upload to PyPi" @echo "tag: tag the repository with the current version\n" +version: + @hatch version + install: ./install.sh --unstable @@ -47,7 +50,7 @@ pytest: nopost: @bash check.sh --nopost -tag: +tag: version git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}" build: check diff --git a/install.sh b/install.sh index bb671f2..3db90bc 100755 --- a/install.sh +++ b/install.sh @@ -58,11 +58,6 @@ find_config() { 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" } @@ -156,7 +151,8 @@ function apt_pkg_install { sudo apt update APT_HAS_UPDATED=true fi - sudo apt install -y "$PACKAGES" + # shellcheck disable=SC2086 + sudo apt install -y $PACKAGES check_for_error if [ -f "$UNINSTALLER" ]; then echo "apt uninstall -y $PACKAGES" >> "$UNINSTALLER" diff --git a/tox.ini b/tox.ini index 44c8654..4726cef 100644 --- a/tox.ini +++ b/tox.ini @@ -20,7 +20,7 @@ commands = python -m build --no-isolation python -m twine check dist/* isort --check . - ruff . + ruff check . codespell . deps = check-manifest From 29846a6612cd90855a38d8305408914efb8a33d1 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Thu, 16 May 2024 14:01:23 +0100 Subject: [PATCH 5/6] QA: Move library import to a fixture. --- tests/conftest.py | 9 +++++++++ tests/test_features.py | 30 ++++++++++-------------------- 2 files changed, 19 insertions(+), 20 deletions(-) diff --git a/tests/conftest.py b/tests/conftest.py index 5c8439f..0f13a57 100644 --- a/tests/conftest.py +++ b/tests/conftest.py @@ -1,3 +1,5 @@ +import sys + import pytest from i2cdevice import MockSMBus @@ -5,3 +7,10 @@ @pytest.fixture(scope='function', autouse=False) def i2c_dev(): yield MockSMBus(1) + + +@pytest.fixture(scope='function', autouse=False) +def DRV8830(): + from drv8830 import DRV8830 + yield DRV8830 + del sys.modules["drv8830"] diff --git a/tests/test_features.py b/tests/test_features.py index 5091b4d..dd76bb1 100644 --- a/tests/test_features.py +++ b/tests/test_features.py @@ -1,62 +1,52 @@ -def test_forward(i2c_dev): - from drv8830 import DRV8830 +def test_forward(DRV8830, i2c_dev): drv8830 = DRV8830(i2c_dev=i2c_dev) drv8830.forward() -def test_reverse(i2c_dev): - from drv8830 import DRV8830 +def test_reverse(DRV8830, i2c_dev): drv8830 = DRV8830(i2c_dev=i2c_dev) drv8830.reverse() -def test_brake(i2c_dev): - from drv8830 import DRV8830 +def test_brake(DRV8830, i2c_dev): drv8830 = DRV8830(i2c_dev=i2c_dev) drv8830.brake() -def test_coast(i2c_dev): - from drv8830 import DRV8830 +def test_coast(DRV8830, i2c_dev): drv8830 = DRV8830(i2c_dev=i2c_dev) drv8830.coast() -def test_set_outputs(i2c_dev): - from drv8830 import DRV8830 +def test_set_outputs(DRV8830, i2c_dev): drv8830 = DRV8830(i2c_dev=i2c_dev) drv8830.set_outputs(out1=0, out2=0) -def test_set_voltage(i2c_dev): - from drv8830 import DRV8830 +def test_set_voltage(DRV8830, i2c_dev): drv8830 = DRV8830(i2c_dev=i2c_dev) drv8830.set_voltage(5.06) assert drv8830.get_voltage() == 5.06 -def test_set_voltage_snap(i2c_dev): +def test_set_voltage_snap(DRV8830, i2c_dev): # Should snap to the nearest available voltage and read back correctly - from drv8830 import DRV8830 drv8830 = DRV8830(i2c_dev=i2c_dev) drv8830.set_voltage(0.82) assert drv8830.get_voltage() == 0.80 -def test_voltage_out_of_range(i2c_dev): - from drv8830 import DRV8830 +def test_voltage_out_of_range(DRV8830, i2c_dev): drv8830 = DRV8830(i2c_dev=i2c_dev) drv8830.set_voltage(0) assert drv8830.get_voltage() == 0 -def test_get_fault(i2c_dev): - from drv8830 import DRV8830 +def test_get_fault(DRV8830, i2c_dev): drv8830 = DRV8830(i2c_dev=i2c_dev) assert drv8830.get_fault().current_limit == 0 -def test_clear_fault(i2c_dev): - from drv8830 import DRV8830 +def test_clear_fault(DRV8830, i2c_dev): drv8830 = DRV8830(i2c_dev=i2c_dev) drv8830.clear_fault() From 1cfd1ac43928936c0f6db5e486801fef39d1bf93 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Thu, 16 May 2024 14:03:06 +0100 Subject: [PATCH 6/6] Prep for v1.0.0. --- CHANGELOG.md | 6 ++++++ README.md | 30 +++++++++++++++++++++++++----- drv8830/__init__.py | 2 +- 3 files changed, 32 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0f98d12..500f13f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +1.0.0 +----- + +* Repackage to hatch/pyproject.toml +* Bump to i2cdevice 1.0.0 + 0.0.1 ----- diff --git a/README.md b/README.md index 88242bd..755e2fe 100644 --- a/README.md +++ b/README.md @@ -7,13 +7,33 @@ # Installing -Stable library from PyPi: +If you've already set up a Python virtual environment, you can also install the stable library manually from PyPi: -* Just run `python3 -m pip install drv8830` +``` +pip install drv8830 +``` + +Otherwise our install script will set one up for you. + +Stable library from GitHub: + +``` +git clone https://github.com/pimoroni/drv8830-python +cd drv8830-python +./install.sh +``` Latest/development library from GitHub: -* `git clone https://github.com/pimoroni/drv8830-python` -* `cd drv8830-python` -* `./install.sh --unstable` +``` +git clone https://github.com/pimoroni/drv8830-python +cd drv8830-python +./install.sh --unstable +``` + +**Note** Libraries will be installed in the "pimoroni" virtual environment, you will need to activate it to run examples: + +``` +source ~/.virtualenvs/pimoroni/bin/activate +``` diff --git a/drv8830/__init__.py b/drv8830/__init__.py index f4e72e4..bdf9629 100644 --- a/drv8830/__init__.py +++ b/drv8830/__init__.py @@ -1,7 +1,7 @@ from i2cdevice import BitField, Device, Register from i2cdevice.adapter import Adapter, LookupAdapter -__version__ = '0.0.1' +__version__ = '1.0.0' I2C_ADDR1 = 0x60 # Default, both select jumpers bridged (not cut) I2C_ADDR2 = 0x61 # Cut A0