From 5e072bb4bb8ab31baa7d0140f70ec9ca904a327f Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Wed, 8 Nov 2023 12:26:27 +0000 Subject: [PATCH 1/6] Repackage to latest boilerplate --- library/CHANGELOG.txt => CHANGELOG.md | 0 Makefile | 91 +++---- {library/bme280 => bme280}/__init__.py | 0 check.sh | 87 ++++++ install-bullseye.sh | 254 ------------------ install.sh | 177 +++++++----- library/.coveragerc | 4 - library/LICENSE.txt | 21 -- library/MANIFEST.in | 5 - library/README.md | 52 ---- library/setup.py | 33 --- library/tox.ini | 24 -- pyproject.toml | 118 ++++++++ requirements-dev.txt | 9 + library/setup.cfg => setup.cfg | 0 {library/tests => tests}/calibration.py | 0 {library/tests => tests}/test_compensation.py | 0 {library/tests => tests}/test_setup.py | 0 {library/tests => tests}/tools.py | 0 tox.ini | 34 +++ uninstall.sh | 77 ++++-- 21 files changed, 460 insertions(+), 526 deletions(-) rename library/CHANGELOG.txt => CHANGELOG.md (100%) rename {library/bme280 => bme280}/__init__.py (100%) create mode 100755 check.sh delete mode 100755 install-bullseye.sh delete mode 100644 library/.coveragerc delete mode 100644 library/LICENSE.txt delete mode 100644 library/MANIFEST.in delete mode 100644 library/README.md 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/setup.cfg => setup.cfg (100%) rename {library/tests => tests}/calibration.py (100%) rename {library/tests => tests}/test_compensation.py (100%) rename {library/tests => tests}/test_setup.py (100%) rename {library/tests => tests}/tools.py (100%) create mode 100644 tox.ini 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 3c4c65f..9e0c15c 100644 --- a/Makefile +++ b/Makefile @@ -1,71 +1,60 @@ -LIBRARY_VERSION=$(shell grep version library/setup.cfg | awk -F" = " '{print $$2}') -LIBRARY_NAME=$(shell grep name library/setup.cfg | awk -F" = " '{print $$2}') -PACKAGE_NAME="bme280" +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/${PACKAGE_NAME}/__init__.py" - @cat library/${PACKAGE_NAME}/__init__.py | grep "^__version__ = '${LIBRARY_VERSION}'" - -tag: - git tag -a "v${LIBRARY_VERSION}" -m "Version ${LIBRARY_VERSION}" +dev-deps: + python3 -m pip install -r requirements-dev.txt + sudo apt install dos2unix -python-readme: library/README.md - -python-license: library/LICENSE.txt +check: + @bash check.sh -library/README.md: README.md library/CHANGELOG.txt - cp README.md library/README.md - printf "\n# Changelog\n\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/library/bme280/__init__.py b/bme280/__init__.py similarity index 100% rename from library/bme280/__init__.py rename to bme280/__init__.py diff --git a/check.sh b/check.sh new file mode 100755 index 0000000..cbb1565 --- /dev/null +++ b/check.sh @@ -0,0 +1,87 @@ +#!/bin/bash + +# This script handles some basic QA checks on the source + +NOPOST=$1 +LIBRARY_NAME=`hatch project metadata name` +LIBRARY_VERSION=`hatch version | awk -F "." '{print $1"."$2"."$3}'` +POST_VERSION=`hatch version | awk -F "." '{print substr($4,0,length($4))}'` + +success() { + echo -e "$(tput setaf 2)$1$(tput sgr0)" +} + +inform() { + echo -e "$(tput setaf 6)$1$(tput sgr0)" +} + +warning() { + echo -e "$(tput setaf 1)$1$(tput sgr0)" +} + +while [[ $# -gt 0 ]]; do + K="$1" + case $K in + -p|--nopost) + NOPOST=true + shift + ;; + *) + if [[ $1 == -* ]]; then + printf "Unrecognised option: $1\n"; + exit 1 + fi + POSITIONAL_ARGS+=("$1") + shift + esac +done + +inform "Checking $LIBRARY_NAME $LIBRARY_VERSION\n" + +inform "Checking for trailing whitespace..." +grep -IUrn --color "[[:blank:]]$" --exclude-dir=dist --exclude-dir=.tox --exclude-dir=.git --exclude=PKG-INFO +if [[ $? -eq 0 ]]; then + warning "Trailing whitespace found!" + exit 1 +else + success "No trailing whitespace found." +fi +printf "\n" + +inform "Checking for DOS line-endings..." +grep -lIUrn --color $'\r' --exclude-dir=dist --exclude-dir=.tox --exclude-dir=.git --exclude=Makefile +if [[ $? -eq 0 ]]; then + warning "DOS line-endings found!" + exit 1 +else + success "No DOS line-endings found." +fi +printf "\n" + +inform "Checking CHANGELOG.md..." +cat CHANGELOG.md | grep ^${LIBRARY_VERSION} > /dev/null 2>&1 +if [[ $? -eq 1 ]]; then + warning "Changes missing for version ${LIBRARY_VERSION}! Please update CHANGELOG.md." + exit 1 +else + success "Changes found for version ${LIBRARY_VERSION}." +fi +printf "\n" + +inform "Checking for git tag ${LIBRARY_VERSION}..." +git tag -l | grep -E "${LIBRARY_VERSION}$" +if [[ $? -eq 1 ]]; then + warning "Missing git tag for version ${LIBRARY_VERSION}" +fi +printf "\n" + +if [[ $NOPOST ]]; then + inform "Checking for .postN on library version..." + if [[ "$POST_VERSION" != "" ]]; then + warning "Found .$POST_VERSION on library version." + inform "Please only use these for testpypi releases." + exit 1 + else + success "OK" + fi +fi diff --git a/install-bullseye.sh b/install-bullseye.sh deleted file mode 100755 index 76743a9..0000000 --- a/install-bullseye.sh +++ /dev/null @@ -1,254 +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=() -UNSTABLE=false -PYTHON="/usr/bin/python3" -CODENAME=`lsb_release -sc` - -distro_check() { - if [[ $CODENAME != "bullseye" ]]; then - printf "This installer is for Raspberry Pi OS: Bullseye only, current distro: $CODENAME\n" - exit 1 - 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" == '-y' ]; 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 - ;; - -p|--python) - PYTHON=$2 - shift - shift - ;; - *) - if [[ $1 == -* ]]; then - printf "Unrecognised option: $1\n"; - printf "Usage: $USAGE\n"; - exit 1 - fi - POSITIONAL_ARGS+=("$1") - shift - esac -done - -distro_check -user_check - -if [ ! -f "$PYTHON" ]; then - printf "Python path $PYTHON not found!\n" - exit 1 -fi - -PYTHON_VER=`$PYTHON --version` - -inform "Installing. Please wait..." - -$PYTHON -m pip install --upgrade 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_VER...\n" -apt_pkg_install "${PY3_DEPS[@]}" -if $UNSTABLE; then - $PYTHON setup.py install > /dev/null -else - $PYTHON -m pip install --upgrade $LIBRARY_NAME -fi -if [ $? -eq 0 ]; then - success "Done!\n" - echo "$PYTHON -m pip uninstall $LIBRARY_NAME" >> $UNINSTALLER -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 0c73d6a..aebc385 100755 --- a/install.sh +++ b/install.sh @@ -1,31 +1,29 @@ #!/bin/bash - +LIBRARY_NAME=`grep -m 1 name pyproject.toml | awk -F" = " '{print substr($2,2,length($2)-2)}'` 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 +RESOURCES_TOP_DIR=$HOME/Pimoroni +VENV_BASH_SNIPPET=$RESOURCES_DIR/auto_venv.sh +VENV_DIR=$HOME/.virtualenvs/pimoroni WD=`pwd` -USAGE="sudo ./install.sh (--unstable)" +USAGE="./install.sh (--unstable)" POSITIONAL_ARGS=() +FORCE=false UNSTABLE=false -CODENAME=`lsb_release -sc` +PYTHON="python" -if [[ $CODENAME == "bullseye" ]]; then - bash ./install-bullseye.sh - exit $? -fi user_check() { - if [ $(id -u) -ne 0 ]; then - printf "Script must be run as root. Try 'sudo ./install.sh'\n" + if [ $(id -u) -eq 0 ]; then + printf "Script should not be run as root. Try './install.sh'\n" exit 1 fi } confirm() { - if [ "$FORCE" == '-y' ]; then + if $FORCE; then true else read -r -p "$1 [y/N] " response < /dev/tty @@ -58,12 +56,52 @@ warning() { echo -e "$(tput setaf 1)$1$(tput sgr0)" } +venv_bash_snippet() { + if [ ! -f $VENV_BASH_SNIPPET ]; then + cat << EOF > $VENV_BASH_SNIPPET +# Add `source $RESOURCES_DIR/auto_venv.sh` 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 one for you?"; then + if [ ! -f $VENV_DIR/bin/activate ]; then + inform "Creating 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 + else + inform "Found existing virtual Python environment in $VENV_DIR\n" + fi + inform "Activating virtual Python environment in $VENV_DIR..." + inform "source $VENV_DIR/bin/activate\n" + source $VENV_DIR/bin/activate + + else + exit 1 + fi + 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 + sudo cp $CONFIG /boot/$FILENAME mkdir -p $RESOURCES_TOP_DIR/config-backups/ cp $CONFIG $RESOURCES_TOP_DIR/config-backups/$FILENAME if [ -f "$UNINSTALLER" ]; then @@ -88,16 +126,20 @@ function apt_pkg_install { if ! [ "$PACKAGES" == "" ]; then echo "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 if [ -f "$UNINSTALLER" ]; then - echo "apt uninstall -y $PACKAGES" + echo "apt uninstall -y $PACKAGES" >> $UNINSTALLER fi fi } +function pip_pkg_install { + PYTHON_KEYRING_BACKEND=keyring.backends.null.Keyring $PYTHON -m pip install --upgrade "$@" +} + while [[ $# -gt 0 ]]; do K="$1" case $K in @@ -105,6 +147,15 @@ while [[ $# -gt 0 ]]; do UNSTABLE=true shift ;; + -f|--force) + FORCE=true + shift + ;; + -p|--python) + PYTHON=$2 + shift + shift + ;; *) if [[ $1 == -* ]]; then printf "Unrecognised option: $1\n"; @@ -117,28 +168,31 @@ while [[ $# -gt 0 ]]; do done user_check +venv_check -apt_pkg_install python-configparser - -CONFIG_VARS=`python - < $UNINSTALLER @@ -161,42 +222,25 @@ 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" - 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[@]}" +inform "Installing for $PYTHON_VER...\n" +apt_pkg_install "${APT_PACKAGES[@]}" if $UNSTABLE; then - python setup.py install > /dev/null + pip_pkg_install . else - pip install --upgrade $LIBRARY_NAME + pip_pkg_install $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 + echo "$PYTHON -m pip uninstall $LIBRARY_NAME" >> $UNINSTALLER fi cd $WD @@ -215,9 +259,9 @@ for ((i = 0; i < ${#CONFIG_TXT[@]}; i++)); do if ! [ "$CONFIG_LINE" == "" ]; then do_config_backup inform "Adding $CONFIG_LINE to $CONFIG\n" - sed -i "s/^#$CONFIG_LINE/$CONFIG_LINE/" $CONFIG + sudo sed -i "s/^#$CONFIG_LINE/$CONFIG_LINE/" $CONFIG if ! grep -q "^$CONFIG_LINE" $CONFIG; then - printf "$CONFIG_LINE\n" >> $CONFIG + printf "$CONFIG_LINE\n" | sudo tee --append $CONFIG fi fi done @@ -233,13 +277,12 @@ fi printf "\n" -if [ -f "/usr/bin/pydoc" ]; then +if confirm "Would you like to generate documentation?"; then + pip_pkg_install pdoc 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" + $PYTHON -m pdoc $LIBRARY_NAME -o $RESOURCES_DIR/docs > /dev/null + if [ $? -eq 0 ]; then + inform "Documentation saved to $RESOURCES_DIR/docs" success "Done!" else warning "Error: Failed to generate documentation." diff --git a/library/.coveragerc b/library/.coveragerc deleted file mode 100644 index cb1f321..0000000 --- a/library/.coveragerc +++ /dev/null @@ -1,4 +0,0 @@ -[run] -source = bme280 -omit = - .tox/* 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 d39e87b..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 bme280 *.py diff --git a/library/README.md b/library/README.md deleted file mode 100644 index ed413f3..0000000 --- a/library/README.md +++ /dev/null @@ -1,52 +0,0 @@ -# BME280 Temperature, Pressure, & Humidity Sensor - -[![Build Status](https://travis-ci.com/pimoroni/bme280-python.svg?branch=master)](https://travis-ci.com/pimoroni/bme280-python) -[![Coverage Status](https://coveralls.io/repos/github/pimoroni/bme280-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/bme280-python?branch=master) -[![PyPi Package](https://img.shields.io/pypi/v/pimoroni-bme280.svg)](https://pypi.python.org/pypi/pimoroni-bme280) -[![Python Versions](https://img.shields.io/pypi/pyversions/pimoroni-bme280.svg)](https://pypi.python.org/pypi/pimoroni-bme280) - -Suitable for measuring ambient temperature, barometric pressure, and humidity, the BME280 is a great indoor environmental sensor. - -# Pre-requisites - -You must enable: - -* i2c: `sudo raspi-config nonint do_i2c 0` - -You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configuration UI to enable interfaces. - -# Installing - -Stable library from PyPi, the smbus library is also needed: - -* Just run `sudo pip install pimoroni-bme280 smbus` - -Latest/development library from GitHub: - -* `git clone https://github.com/pimoroni/bme280-python` -* `cd bme280-python` -* `sudo ./install.sh` - - -# Changelog - -0.1.1 ------ - -* Fix so package is included in .whl releases - -0.1.0 ------ - -* Switch to setup.cfg -* Match humidity compensation to BOSCH formula - -0.0.2 ------ - -* Update to i2cdevice>=0.0.6 set/get API - -0.0.1 ------ - -* Initial Release diff --git a/library/setup.py b/library/setup.py deleted file mode 100755 index 40d6dbc..0000000 --- a/library/setup.py +++ /dev/null @@ -1,33 +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. -""" - -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() diff --git a/library/tox.ini b/library/tox.ini deleted file mode 100644 index a8f3249..0000000 --- a/library/tox.ini +++ /dev/null @@ -1,24 +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 -deps = - mock - pytest>=3.1 - pytest-cov - -[testenv:qa] -commands = - check-manifest --ignore tox.ini,tests/*,.coveragerc - python setup.py sdist bdist_wheel - twine check dist/* - flake8 --ignore E501 -deps = - check-manifest - flake8 - twine diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..438adfb --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,118 @@ +[build-system] +requires = ["hatchling", "hatch-fancy-pypi-readme"] +build-backend = "hatchling.build" + +[project] +name = "pimoroni-bme280" +dynamic = ["version", "readme"] +description = "Python library for the bme280 temperature, pressure and humidity sensor" +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/bme280-python" +Homepage = "https://www.pimoroni.com" + +[tool.hatch.version] +path = "bme280/__init__.py" + +[tool.hatch.build] +include = [ + "bme280", + "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/setup.cfg b/setup.cfg similarity index 100% rename from library/setup.cfg rename to setup.cfg diff --git a/library/tests/calibration.py b/tests/calibration.py similarity index 100% rename from library/tests/calibration.py rename to tests/calibration.py diff --git a/library/tests/test_compensation.py b/tests/test_compensation.py similarity index 100% rename from library/tests/test_compensation.py rename to tests/test_compensation.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/library/tests/tools.py b/tests/tools.py similarity index 100% rename from library/tests/tools.py rename to tests/tools.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 0709cc0..f213fc5 100755 --- a/uninstall.sh +++ b/uninstall.sh @@ -1,25 +1,72 @@ #!/bin/bash -LIBRARY_VERSION=`cat library/setup.py | grep version | awk -F"'" '{print $2}'` -LIBRARY_NAME=`cat library/setup.py | 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 "$LIBRARY_NAME Python Library: Uninstaller\n\n" + +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 19db39480c6ab42a4254ce3e78b1abe8b830083a Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Wed, 8 Nov 2023 12:35:56 +0000 Subject: [PATCH 2/6] QA: Apply isort suggestions. --- bme280/__init__.py | 4 ++-- examples/all-values.py | 2 ++ examples/compensated-temperature.py | 3 ++- examples/temperature-compare.py | 2 ++ examples/temperature-forced-mode.py | 2 ++ tests/test_compensation.py | 15 ++++++++++----- tests/test_setup.py | 1 + 7 files changed, 21 insertions(+), 8 deletions(-) diff --git a/bme280/__init__.py b/bme280/__init__.py index bef640b..ae0da09 100644 --- a/bme280/__init__.py +++ b/bme280/__init__.py @@ -1,9 +1,9 @@ """BME280 Driver.""" -from i2cdevice import Device, Register, BitField, _int_to_bytes -from i2cdevice.adapter import LookupAdapter, Adapter import struct import time +from i2cdevice import BitField, Device, Register, _int_to_bytes +from i2cdevice.adapter import Adapter, LookupAdapter __version__ = '0.1.1' diff --git a/examples/all-values.py b/examples/all-values.py index 2907d80..15b0cd5 100755 --- a/examples/all-values.py +++ b/examples/all-values.py @@ -1,10 +1,12 @@ #!/usr/bin/env python import time + try: from smbus2 import SMBus except ImportError: from smbus import SMBus + from bme280 import BME280 print("""all-values.py - Read temperature, pressure, and humidity diff --git a/examples/compensated-temperature.py b/examples/compensated-temperature.py index 807d353..72dbc84 100755 --- a/examples/compensated-temperature.py +++ b/examples/compensated-temperature.py @@ -1,9 +1,10 @@ #!/usr/bin/env python import time -from bme280 import BME280 from subprocess import PIPE, Popen +from bme280 import BME280 + try: from smbus2 import SMBus except ImportError: diff --git a/examples/temperature-compare.py b/examples/temperature-compare.py index f5681a1..d9041a1 100755 --- a/examples/temperature-compare.py +++ b/examples/temperature-compare.py @@ -1,10 +1,12 @@ #!/usr/bin/env python import time + try: from smbus2 import SMBus except ImportError: from smbus import SMBus + from bme280 import BME280 print("""temperature-compare.py - Compares oversampling levels diff --git a/examples/temperature-forced-mode.py b/examples/temperature-forced-mode.py index c3bdb5c..964f1cd 100755 --- a/examples/temperature-forced-mode.py +++ b/examples/temperature-forced-mode.py @@ -1,10 +1,12 @@ #!/usr/bin/env python import time + try: from smbus2 import SMBus except ImportError: from smbus import SMBus + from bme280 import BME280 # Initialise the BME280 diff --git a/tests/test_compensation.py b/tests/test_compensation.py index 4126a56..34dc768 100644 --- a/tests/test_compensation.py +++ b/tests/test_compensation.py @@ -10,9 +10,10 @@ def test_temperature(): + from calibration import BME280Calibration from tools import SMBusFakeDevice + from bme280 import BME280 - from calibration import BME280Calibration dev = SMBusFakeDevice(1) # Load the fake temperature into the virtual registers @@ -30,9 +31,10 @@ def test_temperature(): def test_temperature_forced(): + from calibration import BME280Calibration from tools import SMBusFakeDevice + from bme280 import BME280 - from calibration import BME280Calibration dev = SMBusFakeDevice(1) # Load the fake temperature into the virtual registers @@ -50,9 +52,10 @@ def test_temperature_forced(): def test_pressure(): + from calibration import BME280Calibration from tools import SMBusFakeDevice + from bme280 import BME280 - from calibration import BME280Calibration dev = SMBusFakeDevice(1) # Load the fake temperature values into the virtual registers @@ -76,9 +79,10 @@ def test_pressure(): def test_altitude(): + from calibration import BME280Calibration from tools import SMBusFakeDevice + from bme280 import BME280 - from calibration import BME280Calibration dev = SMBusFakeDevice(1) # Load the fake temperature values into the virtual registers @@ -102,9 +106,10 @@ def test_altitude(): def test_humidity(): + from calibration import BME280Calibration from tools import SMBusFakeDevice + from bme280 import BME280 - from calibration import BME280Calibration dev = SMBusFakeDevice(1) # Load the fake temperature values into the virtual registers diff --git a/tests/test_setup.py b/tests/test_setup.py index 3e800ca..1e3410b 100644 --- a/tests/test_setup.py +++ b/tests/test_setup.py @@ -1,4 +1,5 @@ import sys + import mock import pytest From 6163f1f91e50131c1304fa0edf4a6861fc8fd619 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Wed, 8 Nov 2023 12:38:41 +0000 Subject: [PATCH 3/6] QA: Apply black reformatting. --- bme280/__init__.py | 196 +++++++++++++--------------- examples/all-values.py | 8 +- examples/compensated-temperature.py | 12 +- examples/dump-calibration.py | 10 +- examples/local_altitude.py | 12 +- examples/relative-altitude.py | 8 +- examples/temperature-compare.py | 8 +- examples/temperature-forced-mode.py | 2 +- tests/calibration.py | 1 + tests/test_compensation.py | 51 ++++---- tests/test_setup.py | 11 +- tests/tools.py | 2 +- 12 files changed, 166 insertions(+), 155 deletions(-) diff --git a/bme280/__init__.py b/bme280/__init__.py index ae0da09..8e116d7 100644 --- a/bme280/__init__.py +++ b/bme280/__init__.py @@ -5,7 +5,7 @@ from i2cdevice import BitField, Device, Register, _int_to_bytes from i2cdevice.adapter import Adapter, LookupAdapter -__version__ = '0.1.1' +__version__ = "0.1.1" CHIP_ID = 0x60 I2C_ADDRESS_GND = 0x76 @@ -25,14 +25,14 @@ class S16Adapter(Adapter): """Convert unsigned 16bit integer to signed.""" def _decode(self, value): - return struct.unpack('""") +>""" +) print("You have told us the QNH is", local_qnh) # converts the input into a floating point number diff --git a/examples/relative-altitude.py b/examples/relative-altitude.py index 9bd1166..0e498ae 100755 --- a/examples/relative-altitude.py +++ b/examples/relative-altitude.py @@ -8,11 +8,13 @@ from smbus import SMBus from bme280 import BME280 -print("""relative-altitude.py - Calculates relative altitude from pressure. +print( + """relative-altitude.py - Calculates relative altitude from pressure. Press Ctrl+C to exit! -""") +""" +) # Initialise the BME280 bus = SMBus(1) @@ -34,5 +36,5 @@ while True: altitude = bme280.get_altitude(qnh=baseline) - print('Relative altitude: {:05.2f} metres'.format(altitude)) + print("Relative altitude: {:05.2f} metres".format(altitude)) time.sleep(1) diff --git a/examples/temperature-compare.py b/examples/temperature-compare.py index d9041a1..e58ddfc 100755 --- a/examples/temperature-compare.py +++ b/examples/temperature-compare.py @@ -9,12 +9,14 @@ from bme280 import BME280 -print("""temperature-compare.py - Compares oversampling levels +print( + """temperature-compare.py - Compares oversampling levels (requires two BME280s with different addresses). Press Ctrl+C to exit! -""") +""" +) # Initialise the BME280 bus = SMBus(1) @@ -31,5 +33,5 @@ while True: temperatureA = bme280A.get_temperature() temperatureB = bme280B.get_temperature() - print('Forced: {:05.2f}*C Normal: {:05.2f}*C D: {:05.2f}'.format(temperatureA, temperatureB, abs(temperatureA - temperatureB))) + print("Forced: {:05.2f}*C Normal: {:05.2f}*C D: {:05.2f}".format(temperatureA, temperatureB, abs(temperatureA - temperatureB))) time.sleep(1) diff --git a/examples/temperature-forced-mode.py b/examples/temperature-forced-mode.py index 964f1cd..08b1362 100755 --- a/examples/temperature-forced-mode.py +++ b/examples/temperature-forced-mode.py @@ -21,5 +21,5 @@ while True: temperature = bme280.get_temperature() - print('{:05.2f}*C'.format(temperature)) + print("{:05.2f}*C".format(temperature)) time.sleep(1) diff --git a/tests/calibration.py b/tests/calibration.py index 1b231c0..b3a7665 100644 --- a/tests/calibration.py +++ b/tests/calibration.py @@ -3,6 +3,7 @@ class BME280Calibration(bme280.BME280Calibration): """Prefil the calibration class with known values.""" + def __init__(self): bme280.BME280Calibration.__init__(self) diff --git a/tests/test_compensation.py b/tests/test_compensation.py index 34dc768..0acff36 100644 --- a/tests/test_compensation.py +++ b/tests/test_compensation.py @@ -14,12 +14,13 @@ def test_temperature(): from tools import SMBusFakeDevice from bme280 import BME280 + dev = SMBusFakeDevice(1) # Load the fake temperature into the virtual registers - dev.regs[0xfc] = (TEST_TEMP_RAW & 0x0000F) << 4 - dev.regs[0xfb] = (TEST_TEMP_RAW & 0x00FF0) >> 4 - dev.regs[0xfa] = (TEST_TEMP_RAW & 0xFF000) >> 12 + dev.regs[0xFC] = (TEST_TEMP_RAW & 0x0000F) << 4 + dev.regs[0xFB] = (TEST_TEMP_RAW & 0x00FF0) >> 4 + dev.regs[0xFA] = (TEST_TEMP_RAW & 0xFF000) >> 12 bme280 = BME280(i2c_dev=dev) bme280.setup() @@ -35,12 +36,13 @@ def test_temperature_forced(): from tools import SMBusFakeDevice from bme280 import BME280 + dev = SMBusFakeDevice(1) # Load the fake temperature into the virtual registers - dev.regs[0xfc] = (TEST_TEMP_RAW & 0x0000F) << 4 - dev.regs[0xfb] = (TEST_TEMP_RAW & 0x00FF0) >> 4 - dev.regs[0xfa] = (TEST_TEMP_RAW & 0xFF000) >> 12 + dev.regs[0xFC] = (TEST_TEMP_RAW & 0x0000F) << 4 + dev.regs[0xFB] = (TEST_TEMP_RAW & 0x00FF0) >> 4 + dev.regs[0xFA] = (TEST_TEMP_RAW & 0xFF000) >> 12 bme280 = BME280(i2c_dev=dev) bme280.setup(mode="forced") @@ -56,18 +58,19 @@ def test_pressure(): from tools import SMBusFakeDevice from bme280 import BME280 + dev = SMBusFakeDevice(1) # Load the fake temperature values into the virtual registers # Pressure is temperature compensated!!! - dev.regs[0xfc] = (TEST_TEMP_RAW & 0x0000F) << 4 - dev.regs[0xfb] = (TEST_TEMP_RAW & 0x00FF0) >> 4 - dev.regs[0xfa] = (TEST_TEMP_RAW & 0xFF000) >> 12 + dev.regs[0xFC] = (TEST_TEMP_RAW & 0x0000F) << 4 + dev.regs[0xFB] = (TEST_TEMP_RAW & 0x00FF0) >> 4 + dev.regs[0xFA] = (TEST_TEMP_RAW & 0xFF000) >> 12 # Load the fake pressure values - dev.regs[0xf9] = (TEST_PRES_RAW & 0x0000F) << 4 - dev.regs[0xf8] = (TEST_PRES_RAW & 0x00FF0) >> 4 - dev.regs[0xf7] = (TEST_PRES_RAW & 0xFF000) >> 12 + dev.regs[0xF9] = (TEST_PRES_RAW & 0x0000F) << 4 + dev.regs[0xF8] = (TEST_PRES_RAW & 0x00FF0) >> 4 + dev.regs[0xF7] = (TEST_PRES_RAW & 0xFF000) >> 12 bme280 = BME280(i2c_dev=dev) bme280.setup() @@ -83,18 +86,19 @@ def test_altitude(): from tools import SMBusFakeDevice from bme280 import BME280 + dev = SMBusFakeDevice(1) # Load the fake temperature values into the virtual registers # Pressure is temperature compensated!!! - dev.regs[0xfc] = (TEST_TEMP_RAW & 0x0000F) << 4 - dev.regs[0xfb] = (TEST_TEMP_RAW & 0x00FF0) >> 4 - dev.regs[0xfa] = (TEST_TEMP_RAW & 0xFF000) >> 12 + dev.regs[0xFC] = (TEST_TEMP_RAW & 0x0000F) << 4 + dev.regs[0xFB] = (TEST_TEMP_RAW & 0x00FF0) >> 4 + dev.regs[0xFA] = (TEST_TEMP_RAW & 0xFF000) >> 12 # Load the fake pressure values - dev.regs[0xf9] = (TEST_PRES_RAW & 0x0000F) << 4 - dev.regs[0xf8] = (TEST_PRES_RAW & 0x00FF0) >> 4 - dev.regs[0xf7] = (TEST_PRES_RAW & 0xFF000) >> 12 + dev.regs[0xF9] = (TEST_PRES_RAW & 0x0000F) << 4 + dev.regs[0xF8] = (TEST_PRES_RAW & 0x00FF0) >> 4 + dev.regs[0xF7] = (TEST_PRES_RAW & 0xFF000) >> 12 bme280 = BME280(i2c_dev=dev) bme280.setup() @@ -110,17 +114,18 @@ def test_humidity(): from tools import SMBusFakeDevice from bme280 import BME280 + dev = SMBusFakeDevice(1) # Load the fake temperature values into the virtual registers # Humidity is temperature compensated!!! - dev.regs[0xfc] = (TEST_TEMP_RAW & 0x0000F) << 4 - dev.regs[0xfb] = (TEST_TEMP_RAW & 0x00FF0) >> 4 - dev.regs[0xfa] = (TEST_TEMP_RAW & 0xFF000) >> 12 + dev.regs[0xFC] = (TEST_TEMP_RAW & 0x0000F) << 4 + dev.regs[0xFB] = (TEST_TEMP_RAW & 0x00FF0) >> 4 + dev.regs[0xFA] = (TEST_TEMP_RAW & 0xFF000) >> 12 # Load the fake humidity values - dev.regs[0xfd] = TEST_HUM_RAW >> 8 - dev.regs[0xfe] = TEST_HUM_RAW & 0xFF + dev.regs[0xFD] = TEST_HUM_RAW >> 8 + dev.regs[0xFE] = TEST_HUM_RAW & 0xFF bme280 = BME280(i2c_dev=dev) bme280.setup() diff --git a/tests/test_setup.py b/tests/test_setup.py index 1e3410b..d7f7279 100644 --- a/tests/test_setup.py +++ b/tests/test_setup.py @@ -5,8 +5,9 @@ def test_setup_not_present(): - sys.modules['smbus'] = mock.MagicMock() + sys.modules["smbus"] = mock.MagicMock() from bme280 import BME280 + bme280 = BME280() with pytest.raises(RuntimeError): bme280.setup() @@ -14,19 +15,23 @@ def test_setup_not_present(): def test_setup_mock_present(): from tools import SMBusFakeDevice + smbus = mock.Mock() smbus.SMBus = SMBusFakeDevice - sys.modules['smbus'] = smbus + sys.modules["smbus"] = smbus from bme280 import BME280 + bme280 = BME280() bme280.setup() def test_setup_forced_mode(): from tools import SMBusFakeDevice + smbus = mock.Mock() smbus.SMBus = SMBusFakeDevice - sys.modules['smbus'] = smbus + sys.modules["smbus"] = smbus from bme280 import BME280 + bme280 = BME280() bme280.setup(mode="forced") diff --git a/tests/tools.py b/tests/tools.py index c64d6f8..668bf81 100644 --- a/tests/tools.py +++ b/tests/tools.py @@ -4,4 +4,4 @@ class SMBusFakeDevice(MockSMBus): def __init__(self, i2c_bus): MockSMBus.__init__(self, i2c_bus) - self.regs[0xD0] = 0x60 # Fake chip ID + self.regs[0xD0] = 0x60 # Fake chip ID From 4579405d6d927fb5531949708c685d7c6487a257 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Wed, 8 Nov 2023 13:06:19 +0000 Subject: [PATCH 4/6] CI: Fixup tests. --- tests/conftest.py | 35 ++++++++++++++++++ tests/test_compensation.py | 75 +++++++++++++++----------------------- tests/test_setup.py | 38 ++++++------------- tests/tools.py | 7 ---- 4 files changed, 76 insertions(+), 79 deletions(-) create mode 100644 tests/conftest.py delete mode 100644 tests/tools.py diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..984648c --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,35 @@ +import sys + +import mock +import pytest +from i2cdevice import MockSMBus + + +class SMBusFakeDevice(MockSMBus): + def __init__(self, i2c_bus): + MockSMBus.__init__(self, i2c_bus) + self.regs[0xD0] = 0x60 # Fake chip ID + + +@pytest.fixture(scope="function", autouse=False) +def bme280(): + import bme280 + yield bme280 + del sys.modules["bme280"] + + +@pytest.fixture(scope="function", autouse=False) +def smbus2_mock(): + smbus = mock.Mock() + smbus.SMBus = SMBusFakeDevice + sys.modules["smbus2"] = smbus + yield smbus + del sys.modules["smbus2"] + + +@pytest.fixture(scope="function", autouse=False) +def smbus2(): + smbus = mock.Mock() + sys.modules["smbus2"] = smbus + yield smbus + del sys.modules["smbus2"] diff --git a/tests/test_compensation.py b/tests/test_compensation.py index 0acff36..964ee98 100644 --- a/tests/test_compensation.py +++ b/tests/test_compensation.py @@ -9,57 +9,48 @@ TEST_HUM_CMP = 68.66996648709039 -def test_temperature(): +def test_temperature(smbus2_mock, bme280): from calibration import BME280Calibration - from tools import SMBusFakeDevice - from bme280 import BME280 - - dev = SMBusFakeDevice(1) + dev = smbus2_mock.SMBus(1) # Load the fake temperature into the virtual registers dev.regs[0xFC] = (TEST_TEMP_RAW & 0x0000F) << 4 dev.regs[0xFB] = (TEST_TEMP_RAW & 0x00FF0) >> 4 dev.regs[0xFA] = (TEST_TEMP_RAW & 0xFF000) >> 12 - bme280 = BME280(i2c_dev=dev) - bme280.setup() + sensor = bme280.BME280(i2c_dev=dev) + sensor.setup() # Replace the loaded calibration with our known values - bme280.calibration = BME280Calibration() + sensor.calibration = BME280Calibration() - assert round(bme280.get_temperature(), 4) == round(TEST_TEMP_CMP, 4) + assert round(sensor.get_temperature(), 4) == round(TEST_TEMP_CMP, 4) -def test_temperature_forced(): +def test_temperature_forced(smbus2_mock, bme280): from calibration import BME280Calibration - from tools import SMBusFakeDevice - - from bme280 import BME280 - dev = SMBusFakeDevice(1) + dev = smbus2_mock.SMBus(1) # Load the fake temperature into the virtual registers dev.regs[0xFC] = (TEST_TEMP_RAW & 0x0000F) << 4 dev.regs[0xFB] = (TEST_TEMP_RAW & 0x00FF0) >> 4 dev.regs[0xFA] = (TEST_TEMP_RAW & 0xFF000) >> 12 - bme280 = BME280(i2c_dev=dev) - bme280.setup(mode="forced") + sensor = bme280.BME280(i2c_dev=dev) + sensor.setup(mode="forced") # Replace the loaded calibration with our known values - bme280.calibration = BME280Calibration() + sensor.calibration = BME280Calibration() - assert round(bme280.get_temperature(), 4) == round(TEST_TEMP_CMP, 4) + assert round(sensor.get_temperature(), 4) == round(TEST_TEMP_CMP, 4) -def test_pressure(): +def test_pressure(smbus2_mock, bme280): from calibration import BME280Calibration - from tools import SMBusFakeDevice - - from bme280 import BME280 - dev = SMBusFakeDevice(1) + dev = smbus2_mock.SMBus(1) # Load the fake temperature values into the virtual registers # Pressure is temperature compensated!!! @@ -72,22 +63,19 @@ def test_pressure(): dev.regs[0xF8] = (TEST_PRES_RAW & 0x00FF0) >> 4 dev.regs[0xF7] = (TEST_PRES_RAW & 0xFF000) >> 12 - bme280 = BME280(i2c_dev=dev) - bme280.setup() + sensor = bme280.BME280(i2c_dev=dev) + sensor.setup() # Replace the loaded calibration with our known values - bme280.calibration = BME280Calibration() + sensor.calibration = BME280Calibration() - assert round(bme280.get_pressure(), 4) == round(TEST_PRES_CMP, 4) + assert round(sensor.get_pressure(), 4) == round(TEST_PRES_CMP, 4) -def test_altitude(): +def test_altitude(smbus2_mock, bme280): from calibration import BME280Calibration - from tools import SMBusFakeDevice - from bme280 import BME280 - - dev = SMBusFakeDevice(1) + dev = smbus2_mock.SMBus(1) # Load the fake temperature values into the virtual registers # Pressure is temperature compensated!!! @@ -100,22 +88,19 @@ def test_altitude(): dev.regs[0xF8] = (TEST_PRES_RAW & 0x00FF0) >> 4 dev.regs[0xF7] = (TEST_PRES_RAW & 0xFF000) >> 12 - bme280 = BME280(i2c_dev=dev) - bme280.setup() + sensor = bme280.BME280(i2c_dev=dev) + sensor.setup() # Replace the loaded calibration with our known values - bme280.calibration = BME280Calibration() + sensor.calibration = BME280Calibration() - assert round(bme280.get_altitude(), 4) == round(TEST_ALT_CMP, 4) + assert round(sensor.get_altitude(), 4) == round(TEST_ALT_CMP, 4) -def test_humidity(): +def test_humidity(smbus2_mock, bme280): from calibration import BME280Calibration - from tools import SMBusFakeDevice - - from bme280 import BME280 - dev = SMBusFakeDevice(1) + dev = smbus2_mock.SMBus(1) # Load the fake temperature values into the virtual registers # Humidity is temperature compensated!!! @@ -127,10 +112,10 @@ def test_humidity(): dev.regs[0xFD] = TEST_HUM_RAW >> 8 dev.regs[0xFE] = TEST_HUM_RAW & 0xFF - bme280 = BME280(i2c_dev=dev) - bme280.setup() + sensor = bme280.BME280(i2c_dev=dev) + sensor.setup() # Replace the loaded calibration with our known values - bme280.calibration = BME280Calibration() + sensor.calibration = BME280Calibration() - assert round(bme280.get_humidity(), 4) == round(TEST_HUM_CMP, 4) + assert round(sensor.get_humidity(), 4) == round(TEST_HUM_CMP, 4) diff --git a/tests/test_setup.py b/tests/test_setup.py index d7f7279..613a7ef 100644 --- a/tests/test_setup.py +++ b/tests/test_setup.py @@ -1,37 +1,21 @@ -import sys - -import mock import pytest -def test_setup_not_present(): - sys.modules["smbus"] = mock.MagicMock() - from bme280 import BME280 +def test_setup_not_present(smbus2_mock, bme280): + dev = smbus2_mock.SMBus(1) + dev.regs[0xD0] = 0x00 # Incorrect chip ID - bme280 = BME280() + sensor = bme280.BME280(i2c_dev=dev) with pytest.raises(RuntimeError): - bme280.setup() - - -def test_setup_mock_present(): - from tools import SMBusFakeDevice - - smbus = mock.Mock() - smbus.SMBus = SMBusFakeDevice - sys.modules["smbus"] = smbus - from bme280 import BME280 + sensor.setup() - bme280 = BME280() - bme280.setup() +def test_setup_mock_present(smbus2_mock, bme280): + sensor = bme280.BME280() + sensor.setup() -def test_setup_forced_mode(): - from tools import SMBusFakeDevice - smbus = mock.Mock() - smbus.SMBus = SMBusFakeDevice - sys.modules["smbus"] = smbus - from bme280 import BME280 +def test_setup_forced_mode(smbus2_mock, bme280): - bme280 = BME280() - bme280.setup(mode="forced") + sensor = bme280.BME280() + sensor.setup(mode="forced") diff --git a/tests/tools.py b/tests/tools.py deleted file mode 100644 index 668bf81..0000000 --- a/tests/tools.py +++ /dev/null @@ -1,7 +0,0 @@ -from i2cdevice import MockSMBus - - -class SMBusFakeDevice(MockSMBus): - def __init__(self, i2c_bus): - MockSMBus.__init__(self, i2c_bus) - self.regs[0xD0] = 0x60 # Fake chip ID From 4069cc07a844900b895f66ad38fea14751dc3f17 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Wed, 8 Nov 2023 13:10:49 +0000 Subject: [PATCH 5/6] Update README. --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index a78f0d4..a375fbb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BME280 Temperature, Pressure, & Humidity Sensor -[![Build Status](https://travis-ci.com/pimoroni/bme280-python.svg?branch=master)](https://travis-ci.com/pimoroni/bme280-python) +[![Build Status](https://img.shields.io/github/actions/workflow/status/pimoroni/bme280-python/test.yml?branch=main)](https://github.com/pimoroni/bme280-python/actions/workflows/test.yml) [![Coverage Status](https://coveralls.io/repos/github/pimoroni/bme280-python/badge.svg?branch=master)](https://coveralls.io/github/pimoroni/bme280-python?branch=master) [![PyPi Package](https://img.shields.io/pypi/v/pimoroni-bme280.svg)](https://pypi.python.org/pypi/pimoroni-bme280) [![Python Versions](https://img.shields.io/pypi/pyversions/pimoroni-bme280.svg)](https://pypi.python.org/pypi/pimoroni-bme280) @@ -19,7 +19,7 @@ You can optionally run `sudo raspi-config` or the graphical Raspberry Pi Configu Stable library from PyPi, the smbus library is also needed: -* Just run `sudo pip install pimoroni-bme280 smbus` +* Just run `python3 -m pip install pimoroni-bme280` Latest/development library from GitHub: From 76e33df11d0507bdc388cd9eebd5b8164231c327 Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Wed, 8 Nov 2023 14:44:03 +0000 Subject: [PATCH 6/6] CI: Update CI workflows. --- .github/workflows/build.yml | 41 +++++++++++++++++++++++++++++++++++++ .github/workflows/qa.yml | 36 ++++++++++++++++++++++++++++++++ .github/workflows/test.yml | 25 +++++++++++++--------- 3 files changed, 92 insertions(+), 10 deletions(-) create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/qa.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..87200ef --- /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@v3 + + - name: Set up Python ${{ matrix.python }} + uses: actions/setup-python@v3 + with: + python-version: ${{ matrix.python }} + + - name: Install Dependencies + run: | + make dev-deps + + - name: Build Packages + run: | + make build + + - name: Upload Packages + uses: actions/upload-artifact@v3 + with: + name: ${{ env.RELEASE_FILE }} + path: dist/ diff --git a/.github/workflows/qa.yml b/.github/workflows/qa.yml new file mode 100644 index 0000000..4f85883 --- /dev/null +++ b/.github/workflows/qa.yml @@ -0,0 +1,36 @@ +name: QA + +on: + pull_request: + push: + branches: + - main + +jobs: + test: + name: linting & spelling + runs-on: ubuntu-latest + + env: + TERM: xterm-256color + + steps: + - name: Checkout Code + uses: actions/checkout@v2 + + - name: Set up Python '3,11' + uses: actions/setup-python@v3 + with: + python-version: '3.11' + + - name: Install Dependencies + run: | + make dev-deps + + - name: Run Quality Assurance + run: | + make qa + + - name: Run Code Checks + run: | + make check diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c139ee1..016a678 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,36 +1,41 @@ -name: Python Tests +name: Tests on: pull_request: push: branches: - - master + - main jobs: test: + name: Python ${{ matrix.python }} runs-on: ubuntu-latest strategy: matrix: - python: [2.7, 3.5, 3.7, 3.9] + python: ['3.9', '3.10', '3.11'] steps: - - uses: actions/checkout@v2 + - name: Checkout Code + uses: actions/checkout@v3 + - name: Set up Python ${{ matrix.python }} - uses: actions/setup-python@v2 + uses: actions/setup-python@v3 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' }} +