From 60f0693312ce137946ea3910614976e682fe02c8 Mon Sep 17 00:00:00 2001 From: dherrada Date: Tue, 9 Nov 2021 15:31:27 -0500 Subject: [PATCH 01/47] Updated readthedocs file --- .readthedocs.yaml | 15 +++++++++++++++ .readthedocs.yml | 7 ------- 2 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 .readthedocs.yaml delete mode 100644 .readthedocs.yml diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..95ec218 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,15 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +# Read the Docs configuration file +# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details + +# Required +version: 2 + +python: + version: "3.6" + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 338427a..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt From 4e0449ee2f358c39acab7ce2c5f60704cc5ab473 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 23 Nov 2021 13:06:34 -0600 Subject: [PATCH 02/47] update rtd py version --- .readthedocs.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 95ec218..1335112 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.6" + version: "3.7" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 71e9ce006847ca22791bc78b78a965da19daa58c Mon Sep 17 00:00:00 2001 From: dherrada Date: Thu, 13 Jan 2022 16:27:30 -0500 Subject: [PATCH 03/47] First part of patch Signed-off-by: dherrada --- .../PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md | 2 +- .github/workflows/build.yml | 6 +++--- .github/workflows/release.yml | 8 ++++---- .readthedocs.yaml | 2 +- 4 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md index 71ef8f8..8de294e 100644 --- a/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md +++ b/.github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md @@ -4,7 +4,7 @@ Thank you for contributing! Before you submit a pull request, please read the following. -Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://circuitpython.readthedocs.io/en/latest/docs/design_guide.html +Make sure any changes you're submitting are in line with the CircuitPython Design Guide, available here: https://docs.circuitpython.org/en/latest/docs/design_guide.html If your changes are to documentation, please verify that the documentation builds locally by following the steps found here: https://adafru.it/build-docs diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 331b9e7..b607b17 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -22,10 +22,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.7 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.7 + python-version: "3.x" - name: Versions run: | python3 --version diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6d0015a..a65e5de 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -24,10 +24,10 @@ jobs: awk -F '\/' '{ print tolower($2) }' | tr '_' '-' ) - - name: Set up Python 3.6 - uses: actions/setup-python@v1 + - name: Set up Python 3.x + uses: actions/setup-python@v2 with: - python-version: 3.6 + python-version: "3.x" - name: Versions run: | python3 --version @@ -67,7 +67,7 @@ jobs: echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - name: Set up Python if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - uses: actions/setup-python@v1 + uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 1335112..f8b2891 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -9,7 +9,7 @@ version: 2 python: - version: "3.7" + version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From d2891f5ed4412ac3a36413458a625ef719aa5767 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 24 Jan 2022 16:46:17 -0500 Subject: [PATCH 04/47] Updated docs link, updated python docs link, updated setup.py --- README.rst | 4 ++-- docs/conf.py | 8 ++++---- docs/index.rst | 2 +- setup.py | 2 -- 4 files changed, 7 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 217e3eb..7bf2440 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-pcf8591/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/pcf8591/en/latest/ + :target: https://docs.circuitpython.org/projects/pcf8591/en/latest/ :alt: Documentation Status .. image:: https://img.shields.io/discord/327254708534116352.svg @@ -103,7 +103,7 @@ Usage Example Documentation ============= -API documentation for this library can be found on `Read the Docs `_. +API documentation for this library can be found on `Read the Docs `_. Contributing ============ diff --git a/docs/conf.py b/docs/conf.py index 6fb66fb..b690908 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -29,16 +29,16 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), + "python": ("https://docs.python.org/3", None), "BusDevice": ( - "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", + "https://docs.circuitpython.org/projects/busdevice/en/latest/", None, ), "Register": ( - "https://circuitpython.readthedocs.io/projects/register/en/latest/", + "https://docs.circuitpython.org/projects/register/en/latest/", None, ), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } # Add any paths that contain templates here, relative to this directory. diff --git a/docs/index.rst b/docs/index.rst index 9444d40..6a0d06d 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -30,7 +30,7 @@ Table of Contents :caption: Other Links Download - CircuitPython Reference Documentation + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System diff --git a/setup.py b/setup.py index 2c7fa40..a07699f 100644 --- a/setup.py +++ b/setup.py @@ -49,8 +49,6 @@ "Topic :: System :: Hardware", "License :: OSI Approved :: MIT License", "Programming Language :: Python :: 3", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", ], # What does your project relate to? keywords="adafruit blinka circuitpython micropython pcf8591 Analog Digital Converter " From c04830e1828e26c4333dd75167aa1cae7f556b5e Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Wed, 9 Feb 2022 13:04:35 -0500 Subject: [PATCH 05/47] Consolidate Documentation sections of README --- README.rst | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.rst b/README.rst index 7bf2440..778033d 100644 --- a/README.rst +++ b/README.rst @@ -105,14 +105,11 @@ Documentation API documentation for this library can be found on `Read the Docs `_. +For information on building library documentation, please check out `this guide `_. + Contributing ============ Contributions are welcome! Please read our `Code of Conduct `_ before contributing to help this project stay welcoming. - -Documentation -============= - -For information on building library documentation, please check out `this guide `_. From d588af714e5d698cfa8970fa0dce3f1c660ff665 Mon Sep 17 00:00:00 2001 From: dherrada Date: Mon, 14 Feb 2022 15:35:02 -0500 Subject: [PATCH 06/47] Fixed readthedocs build Signed-off-by: dherrada --- .readthedocs.yaml | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index f8b2891..33c2a61 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,12 @@ # Required version: 2 +build: + os: ubuntu-20.04 + tools: + python: "3" + python: - version: "3.x" install: - requirements: docs/requirements.txt - requirements: requirements.txt From 55296424bae00ba0fbe63a6072049a74d971f067 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Mon, 28 Mar 2022 15:52:04 -0400 Subject: [PATCH 07/47] Update Black to latest. Signed-off-by: Kattni Rembor --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b9fadc..7467c1d 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,7 +4,7 @@ repos: - repo: https://github.com/python/black - rev: 20.8b1 + rev: 22.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool From 941bbfd71617005ed152f4f9ca8a117bce1567c1 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 29 Mar 2022 18:14:22 -0400 Subject: [PATCH 08/47] "Reformatted per new black version" --- adafruit_pcf8591/pcf8591.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_pcf8591/pcf8591.py b/adafruit_pcf8591/pcf8591.py index 1129be2..5195422 100644 --- a/adafruit_pcf8591/pcf8591.py +++ b/adafruit_pcf8591/pcf8591.py @@ -102,7 +102,7 @@ def read(self, channel): @property def dac_enabled(self): - """ Enables the DAC when True, or sets it to tri-state / high-Z when False""" + """Enables the DAC when True, or sets it to tri-state / high-Z when False""" return self._dac_enabled @dac_enabled.setter From 11f3aef9d05d72a2b2c6e0f1400d28ebe93eb390 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Thu, 21 Apr 2022 15:45:16 -0400 Subject: [PATCH 09/47] Updated gitignore Signed-off-by: evaherrada --- .gitignore | 49 +++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 39 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index 2c6ddfd..544ec4a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,18 +1,47 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Kattni Rembor, written for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT +# Do not include files and directories created by your personal work environment, such as the IDE +# you use, except for those already listed here. Pull requests including changes to this file will +# not be accepted. + +# This .gitignore file contains rules for files generated by working with CircuitPython libraries, +# including building Sphinx, testing with pip, and creating a virual environment, as well as the +# MacOS and IDE-specific files generated by using MacOS in general, or the PyCharm or VSCode IDEs. + +# If you find that there are files being generated on your machine that should not be included in +# your git commit, you should create a .gitignore_global file on your computer to include the +# files created by your personal setup. To do so, follow the two steps below. + +# First, create a file called .gitignore_global somewhere convenient for you, and add rules for +# the files you want to exclude from git commits. + +# Second, configure Git to use the exclude file for all Git repositories by running the +# following via commandline, replacing "path/to/your/" with the actual path to your newly created +# .gitignore_global file: +# git config --global core.excludesfile path/to/your/.gitignore_global + +# CircuitPython-specific files *.mpy -.idea + +# Python-specific files __pycache__ -_build *.pyc + +# Sphinx build-specific files +_build + +# This file results from running `pip -e install .` in a local repository +*.egg-info + +# Virtual environment-specific files .env -.python-version -build*/ -bundles + +# MacOS-specific files *.DS_Store -.eggs -dist -**/*.egg-info + +# IDE-specific files +.idea .vscode +*~ From c4b7b887c23289aedc003fd0ae1effd23023f439 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Apr 2022 15:59:08 -0400 Subject: [PATCH 10/47] Patch: Replaced discord badge image --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 778033d..789f676 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/pcf8591/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From ab7350a30d7ae5f4595c45c1098a0584004c3308 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Sun, 24 Apr 2022 13:56:14 -0500 Subject: [PATCH 11/47] change discord badge --- README.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.rst b/README.rst index 789f676..8220627 100644 --- a/README.rst +++ b/README.rst @@ -5,7 +5,7 @@ Introduction :target: https://docs.circuitpython.org/projects/pcf8591/en/latest/ :alt: Documentation Status -.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bundle/blob/main/badges/adafruit_discord.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord From 755fda8291bf9165ffb83fe5d904a4f965df43fc Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 15 May 2022 12:47:47 -0400 Subject: [PATCH 12/47] Patch .pre-commit-config.yaml --- .pre-commit-config.yaml | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7467c1d..3343606 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -3,40 +3,40 @@ # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black + - repo: https://github.com/python/black rev: 22.3.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: black + - repo: https://github.com/fsfe/reuse-tool + rev: v0.14.0 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: reuse + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.2.0 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/pycqa/pylint rev: v2.11.1 hooks: - - id: pylint + - id: pylint name: pylint (library code) types: [python] args: - --disable=consider-using-f-string exclude: "^(docs/|examples/|tests/|setup.py$)" - - id: pylint + - id: pylint name: pylint (example code) description: Run pylint rules on "examples/*.py" files types: [python] files: "^examples/" args: - - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code - - id: pylint + - --disable=missing-docstring,invalid-name,consider-using-f-string,duplicate-code + - id: pylint name: pylint (test code) description: Run pylint rules on "tests/*.py" files types: [python] files: "^tests/" args: - - --disable=missing-docstring,consider-using-f-string,duplicate-code + - --disable=missing-docstring,consider-using-f-string,duplicate-code From c808bdfb43acb77ca2d70ab0fc2734e6203f54e6 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:55 -0400 Subject: [PATCH 13/47] Increase min lines similarity Signed-off-by: Alec Delaney --- .pylintrc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index bd3976d..d411a3c 100644 --- a/.pylintrc +++ b/.pylintrc @@ -252,7 +252,7 @@ ignore-docstrings=yes ignore-imports=yes # Minimum lines number of a similarity. -min-similarity-lines=4 +min-similarity-lines=12 [BASIC] From c61894679a0a794d605a8aaa3f59d1f35caa130c Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Sun, 22 May 2022 00:18:23 -0400 Subject: [PATCH 14/47] Switch to inclusive terminology Signed-off-by: Alec Delaney --- .pylintrc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.pylintrc b/.pylintrc index d411a3c..66d688f 100644 --- a/.pylintrc +++ b/.pylintrc @@ -9,11 +9,11 @@ # run arbitrary code extension-pkg-whitelist= -# Add files or directories to the blacklist. They should be base names, not +# Add files or directories to the ignore-list. They should be base names, not # paths. ignore=CVS -# Add files or directories matching the regex patterns to the blacklist. The +# Add files or directories matching the regex patterns to the ignore-list. The # regex matches against base names, not paths. ignore-patterns= From 2ccc6806d81964d72914c7b039dda5bdd6a5c6a2 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 30 May 2022 14:25:04 -0400 Subject: [PATCH 15/47] Set language to "en" for documentation Signed-off-by: Alec Delaney --- docs/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index b690908..22a03db 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -68,7 +68,7 @@ # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. From a380a35981c36228a1c9b6809d9fcad2f3ed8156 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Tue, 7 Jun 2022 15:34:48 -0400 Subject: [PATCH 16/47] Added cp.org link to index.rst --- docs/index.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 6a0d06d..7f0270a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,7 +29,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat From ed6ed687ec2a91581a6cde5477762d1f7401a168 Mon Sep 17 00:00:00 2001 From: evaherrada Date: Fri, 22 Jul 2022 13:59:10 -0400 Subject: [PATCH 17/47] Changed .env to .venv in README.rst --- README.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 8220627..97c12bd 100644 --- a/README.rst +++ b/README.rst @@ -54,8 +54,8 @@ To install in a virtual environment in your current project: .. code-block:: shell mkdir project-name && cd project-name - python3 -m venv .env - source .env/bin/activate + python3 -m venv .venv + source .venv/bin/activate pip3 install adafruit-circuitpython-pcf8591 Usage Example From 5bfbcf0dd99f68ed2b56fb2a636444fd8f2259cb Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 8 Aug 2022 22:05:53 -0400 Subject: [PATCH 18/47] Switched to pyproject.toml --- .github/workflows/build.yml | 22 +++++++++++-- .github/workflows/release.yml | 17 ++++++---- optional_requirements.txt | 3 ++ pyproject.toml | 50 +++++++++++++++++++++++++--- requirements.txt | 7 ++-- setup.py | 61 ----------------------------------- 6 files changed, 82 insertions(+), 78 deletions(-) create mode 100644 optional_requirements.txt delete mode 100644 setup.py diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index b607b17..22f6582 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -47,13 +47,31 @@ jobs: pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - name: Library version run: git describe --dirty --always --tags + - name: Setup problem matchers + uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - name: Pre-commit hooks run: | pre-commit run --all-files - name: Build assets run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . + - name: Archive bundles + uses: actions/upload-artifact@v2 + with: + name: bundles + path: ${{ github.workspace }}/bundles/ - name: Build docs working-directory: docs run: sphinx-build -E -W -b html . _build/html - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 + - name: Check For pyproject.toml + id: need-pypi + run: | + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) + - name: Build Python package + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') + run: | + pip install --upgrade build twine + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + done; + python -m build + twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index a65e5de..d1b4f8d 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -61,25 +61,28 @@ jobs: runs-on: ubuntu-latest steps: - uses: actions/checkout@v1 - - name: Check For setup.py + - name: Check For pyproject.toml id: need-pypi run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) + echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - name: Set up Python - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') uses: actions/setup-python@v2 with: python-version: '3.x' - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') run: | python -m pip install --upgrade pip - pip install setuptools wheel twine + pip install --upgrade build twine - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') + if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') env: TWINE_USERNAME: ${{ secrets.pypi_username }} TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | - python setup.py sdist + for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do + sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + done; + python -m build twine upload dist/* diff --git a/optional_requirements.txt b/optional_requirements.txt new file mode 100644 index 0000000..d4e27c4 --- /dev/null +++ b/optional_requirements.txt @@ -0,0 +1,3 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense diff --git a/pyproject.toml b/pyproject.toml index f3c35ae..ff419f9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,48 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries # -# SPDX-License-Identifier: Unlicense +# SPDX-License-Identifier: MIT -[tool.black] -target-version = ['py35'] +[build-system] +requires = [ + "setuptools", + "wheel", +] + +[project] +name = "adafruit-circuitpython-pcf8591" +description = "ADC+DAC Combo" +version = "0.0.0-auto.0" +readme = "README.rst" +authors = [ + {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} +] +urls = {Homepage = "https://github.com/adafruit/Adafruit_CircuitPython_PCF8591"} +keywords = [ + "adafruit", + "blinka", + "circuitpython", + "micropython", + "pcf8591", + "Analog", + "Digital", + "Converter", + "Breakout", + "PCF", +] +license = {text = "MIT"} +classifiers = [ + "Intended Audience :: Developers", + "Topic :: Software Development :: Libraries", + "Topic :: Software Development :: Embedded Systems", + "Topic :: System :: Hardware", + "License :: OSI Approved :: MIT License", + "Programming Language :: Python :: 3", +] +dynamic = ["dependencies", "optional-dependencies"] + +[tool.setuptools] +packages = ["adafruit_pcf8591"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index cc92861..fcef575 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,8 +1,7 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # -# SPDX-License-Identifier: MIT +# SPDX-License-Identifier: Unlicense Adafruit-Blinka -adafruit-circuitpython-busdevice adafruit-circuitpython-register +adafruit-circuitpython-busdevice diff --git a/setup.py b/setup.py deleted file mode 100644 index a07699f..0000000 --- a/setup.py +++ /dev/null @@ -1,61 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# SPDX-FileCopyrightText: Copyright (c) 2020 Bryan Siepert for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -"""A setuptools based setup module. - -See: -https://packaging.python.org/en/latest/distributing.html -https://github.com/pypa/sampleproject -""" - -from setuptools import setup, find_packages - -# To use a consistent encoding -from codecs import open -from os import path - -here = path.abspath(path.dirname(__file__)) - -# Get the long description from the README file -with open(path.join(here, "README.rst"), encoding="utf-8") as f: - long_description = f.read() - -setup( - name="adafruit-circuitpython-pcf8591", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="ADC+DAC Combo", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_PCF8591", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - "adafruit-circuitpython-busdevice", - "adafruit-circuitpython-register", - ], - # Choose your license - license="MIT", - # See https://pypi.python.org/pypi?%3Aaction=list_classifiers - classifiers=[ - "Development Status :: 3 - Alpha", - "Intended Audience :: Developers", - "Topic :: Software Development :: Libraries", - "Topic :: System :: Hardware", - "License :: OSI Approved :: MIT License", - "Programming Language :: Python :: 3", - ], - # What does your project relate to? - keywords="adafruit blinka circuitpython micropython pcf8591 Analog Digital Converter " - "Breakout PCF", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, - # CHANGE `py_modules=['...']` TO `packages=['...']` - packages=["adafruit_pcf8591"], -) From c1ab58e5ae5d8e1bc260d1b12645e98c0dd03a34 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 9 Aug 2022 12:03:54 -0400 Subject: [PATCH 19/47] Add setuptools-scm to build system requirements Signed-off-by: Alec Delaney --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index ff419f9..c870350 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -6,6 +6,7 @@ requires = [ "setuptools", "wheel", + "setuptools-scm", ] [project] From e51f126c4e5e1be42e422daf717e56031a6968dd Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 18:09:14 -0400 Subject: [PATCH 20/47] Update version string --- adafruit_pcf8591/pcf8591.py | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_pcf8591/pcf8591.py b/adafruit_pcf8591/pcf8591.py index 5195422..741d429 100644 --- a/adafruit_pcf8591/pcf8591.py +++ b/adafruit_pcf8591/pcf8591.py @@ -26,7 +26,7 @@ * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register """ -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PCF8591.git" # from time import sleep from struct import unpack_from diff --git a/pyproject.toml b/pyproject.toml index c870350..1753b00 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -12,7 +12,7 @@ requires = [ [project] name = "adafruit-circuitpython-pcf8591" description = "ADC+DAC Combo" -version = "0.0.0-auto.0" +version = "0.0.0+auto.0" readme = "README.rst" authors = [ {name = "Adafruit Industries", email = "circuitpython@adafruit.com"} From 9f77e5c3fd2785091528557849461f02dc6a06a2 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 16 Aug 2022 21:09:14 -0400 Subject: [PATCH 21/47] Fix version strings in workflow files --- .github/workflows/build.yml | 2 +- .github/workflows/release.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 22f6582..cb2f60e 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -71,7 +71,7 @@ jobs: run: | pip install --upgrade build twine for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/1.2.3/" $file; + sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; done; python -m build twine check dist/* diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d1b4f8d..f3a0325 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -82,7 +82,7 @@ jobs: TWINE_PASSWORD: ${{ secrets.pypi_password }} run: | for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0-auto.0/${{github.event.release.tag_name}}/" $file; + sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; done; python -m build twine upload dist/* From 33bd456716ae9c50719d6925c66d1c7d9e812259 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Mon, 22 Aug 2022 21:36:31 -0400 Subject: [PATCH 22/47] Keep copyright up to date in documentation --- docs/conf.py | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 22a03db..8ffb537 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -6,6 +6,7 @@ import os import sys +import datetime sys.path.insert(0, os.path.abspath("..")) @@ -51,7 +52,8 @@ # General information about the project. project = "Adafruit PCF8591 Library" -copyright = "2020 Bryan Siepert" +current_year = str(datetime.datetime.now().year) +copyright = current_year + " Bryan Siepert" author = "Bryan Siepert" # The version info for the project you're documenting, acts as replacement for From 2192bbcbdc399f14b2db1dfa2e997c856bc93430 Mon Sep 17 00:00:00 2001 From: Alec Delaney Date: Tue, 23 Aug 2022 17:26:21 -0400 Subject: [PATCH 23/47] Use year duration range for copyright attribution --- docs/conf.py | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 8ffb537..9b7f4ee 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -52,8 +52,14 @@ # General information about the project. project = "Adafruit PCF8591 Library" +creation_year = "2020" current_year = str(datetime.datetime.now().year) -copyright = current_year + " Bryan Siepert" +year_duration = ( + current_year + if current_year == creation_year + else creation_year + " - " + current_year +) +copyright = year_duration + " Bryan Siepert" author = "Bryan Siepert" # The version info for the project you're documenting, acts as replacement for From 857e2cc670fb97ca5bfdbba71b3252b1790c4031 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:02:49 -0400 Subject: [PATCH 24/47] Switching to composite actions --- .github/workflows/build.yml | 67 +---------------------- .github/workflows/release.yml | 88 ------------------------------ .github/workflows/release_gh.yml | 14 +++++ .github/workflows/release_pypi.yml | 14 +++++ 4 files changed, 30 insertions(+), 153 deletions(-) delete mode 100644 .github/workflows/release.yml create mode 100644 .github/workflows/release_gh.yml create mode 100644 .github/workflows/release_pypi.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index cb2f60e..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,68 +10,5 @@ jobs: test: runs-on: ubuntu-latest steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install dependencies - # (e.g. - apt-get: gettext, etc; pip: circuitpython-build-tools, requirements.txt; etc.) - run: | - source actions-ci/install.sh - - name: Pip install Sphinx, pre-commit - run: | - pip install --force-reinstall Sphinx sphinx-rtd-theme pre-commit - - name: Library version - run: git describe --dirty --always --tags - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 - - name: Pre-commit hooks - run: | - pre-commit run --all-files - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Archive bundles - uses: actions/upload-artifact@v2 - with: - name: bundles - path: ${{ github.workspace }}/bundles/ - - name: Build docs - working-directory: docs - run: sphinx-build -E -W -b html . _build/html - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - pip install --upgrade build twine - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/1.2.3/" $file; - done; - python -m build - twine check dist/* + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml deleted file mode 100644 index f3a0325..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,88 +0,0 @@ -# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries -# -# SPDX-License-Identifier: MIT - -name: Release Actions - -on: - release: - types: [published] - -jobs: - upload-release-assets: - runs-on: ubuntu-latest - steps: - - name: Dump GitHub context - env: - GITHUB_CONTEXT: ${{ toJson(github) }} - run: echo "$GITHUB_CONTEXT" - - name: Translate Repo Name For Build Tools filename_prefix - id: repo-name - run: | - echo ::set-output name=repo-name::$( - echo ${{ github.repository }} | - awk -F '\/' '{ print tolower($2) }' | - tr '_' '-' - ) - - name: Set up Python 3.x - uses: actions/setup-python@v2 - with: - python-version: "3.x" - - name: Versions - run: | - python3 --version - - name: Checkout Current Repo - uses: actions/checkout@v1 - with: - submodules: true - - name: Checkout tools repo - uses: actions/checkout@v2 - with: - repository: adafruit/actions-ci-circuitpython-libs - path: actions-ci - - name: Install deps - run: | - source actions-ci/install.sh - - name: Build assets - run: circuitpython-build-bundles --filename_prefix ${{ steps.repo-name.outputs.repo-name }} --library_location . - - name: Upload Release Assets - # the 'official' actions version does not yet support dynamically - # supplying asset names to upload. @csexton's version chosen based on - # discussion in the issue below, as its the simplest to implement and - # allows for selecting files with a pattern. - # https://github.com/actions/upload-release-asset/issues/4 - #uses: actions/upload-release-asset@v1.0.1 - uses: csexton/release-asset-action@master - with: - pattern: "bundles/*" - github-token: ${{ secrets.GITHUB_TOKEN }} - - upload-pypi: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v1 - - name: Check For pyproject.toml - id: need-pypi - run: | - echo ::set-output name=pyproject-toml::$( find . -wholename './pyproject.toml' ) - - name: Set up Python - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - uses: actions/setup-python@v2 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - run: | - python -m pip install --upgrade pip - pip install --upgrade build twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.pyproject-toml, 'pyproject.toml') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - for file in $(find -not -path "./.*" -not -path "./docs*" \( -name "*.py" -o -name "*.toml" \) ); do - sed -i -e "s/0.0.0+auto.0/${{github.event.release.tag_name}}/" $file; - done; - python -m build - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..041a337 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,14 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: Build CI + +on: [pull_request, push] + +jobs: + test: + runs-on: ubuntu-latest + steps: + - name: Run Build CI workflow + uses: adafruit/workflows-circuitpython-libs/build@main From 8570140bc2be1cc2d2468e178da6cc2b1466d8d3 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 00:46:59 -0400 Subject: [PATCH 25/47] Updated pylint version to 2.13.0 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3343606..4c43710 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.11.1 + rev: v2.13.0 hooks: - id: pylint name: pylint (library code) From 570923ade248b63e125c9cd6c23ef70d5cd4b768 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 08:15:20 -0400 Subject: [PATCH 26/47] Update pylint to 2.15.5 --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4c43710..0e5fccc 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -18,7 +18,7 @@ repos: - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.13.0 + rev: v2.15.5 hooks: - id: pylint name: pylint (library code) From ab027955352f540cb9d05d6f2805f2d142af2c4a Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 09:12:44 -0400 Subject: [PATCH 27/47] Fix release CI files --- .github/workflows/release_gh.yml | 14 +++++++++----- .github/workflows/release_pypi.yml | 15 ++++++++++----- 2 files changed, 19 insertions(+), 10 deletions(-) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index 041a337..b8aa8d6 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -2,13 +2,17 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: GitHub Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml index 041a337..65775b7 100644 --- a/.github/workflows/release_pypi.yml +++ b/.github/workflows/release_pypi.yml @@ -2,13 +2,18 @@ # # SPDX-License-Identifier: MIT -name: Build CI +name: PyPI Release Actions -on: [pull_request, push] +on: + release: + types: [published] jobs: - test: + upload-release-assets: runs-on: ubuntu-latest steps: - - name: Run Build CI workflow - uses: adafruit/workflows-circuitpython-libs/build@main + - name: Run PyPI Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-pypi@main + with: + pypi-username: ${{ secrets.pypi_username }} + pypi-password: ${{ secrets.pypi_password }} From 7e34b22ac49b32a992b5dd66d3729dc8eebab5b8 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Fri, 4 Nov 2022 18:34:32 -0400 Subject: [PATCH 28/47] Update .pylintrc for v2.15.5 --- .pylintrc | 43 +++---------------------------------------- 1 file changed, 3 insertions(+), 40 deletions(-) diff --git a/.pylintrc b/.pylintrc index 66d688f..40208c3 100644 --- a/.pylintrc +++ b/.pylintrc @@ -26,7 +26,7 @@ jobs=1 # List of plugins (as comma separated values of python modules names) to load, # usually to register additional checkers. -load-plugins= +load-plugins=pylint.extensions.no_self_use # Pickle collected data for later comparisons. persistent=yes @@ -54,8 +54,8 @@ confidence= # --enable=similarities". If you want to run only the classes checker, but have # no Warning level messages displayed, use"--disable=all --enable=classes # --disable=W" -# disable=import-error,print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call -disable=print-statement,parameter-unpacking,unpacking-in-except,old-raise-syntax,backtick,long-suffix,old-ne-operator,old-octal-literal,import-star-module-level,raw-checker-failed,bad-inline-option,locally-disabled,locally-enabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,apply-builtin,basestring-builtin,buffer-builtin,cmp-builtin,coerce-builtin,execfile-builtin,file-builtin,long-builtin,raw_input-builtin,reduce-builtin,standarderror-builtin,unicode-builtin,xrange-builtin,coerce-method,delslice-method,getslice-method,setslice-method,no-absolute-import,old-division,dict-iter-method,dict-view-method,next-method-called,metaclass-assignment,indexing-exception,raising-string,reload-builtin,oct-method,hex-method,nonzero-method,cmp-method,input-builtin,round-builtin,intern-builtin,unichr-builtin,map-builtin-not-iterating,zip-builtin-not-iterating,range-builtin-not-iterating,filter-builtin-not-iterating,using-cmp-argument,eq-without-hash,div-method,idiv-method,rdiv-method,exception-message-attribute,invalid-str-codec,sys-max-int,bad-python3-import,deprecated-string-function,deprecated-str-translate-call,import-error,bad-continuation,unspecified-encoding +# disable=import-error,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call +disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding # Enable the message, report, category or checker with the given id(s). You can # either give multiple identifier separated by comma (,) or put this option @@ -225,12 +225,6 @@ max-line-length=100 # Maximum number of lines in a module max-module-lines=1000 -# List of optional constructs for which whitespace checking is disabled. `dict- -# separator` is used to allow tabulation in dicts, etc.: {1 : 1,\n222: 2}. -# `trailing-comma` allows a space between comma and closing bracket: (a, ). -# `empty-line` allows space-only lines. -no-space-check=trailing-comma,dict-separator - # Allow the body of a class to be on the same line as the declaration if body # contains single statement. single-line-class-stmt=no @@ -257,38 +251,22 @@ min-similarity-lines=12 [BASIC] -# Naming hint for argument names -argument-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct argument names argument-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for attribute names -attr-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct attribute names attr-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ # Bad variable names which should always be refused, separated by a comma bad-names=foo,bar,baz,toto,tutu,tata -# Naming hint for class attribute names -class-attribute-name-hint=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ - # Regular expression matching correct class attribute names class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$ -# Naming hint for class names -# class-name-hint=[A-Z_][a-zA-Z0-9]+$ -class-name-hint=[A-Z_][a-zA-Z0-9_]+$ - # Regular expression matching correct class names # class-rgx=[A-Z_][a-zA-Z0-9]+$ class-rgx=[A-Z_][a-zA-Z0-9_]+$ -# Naming hint for constant names -const-name-hint=(([A-Z_][A-Z0-9_]*)|(__.*__))$ - # Regular expression matching correct constant names const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ @@ -296,9 +274,6 @@ const-rgx=(([A-Z_][A-Z0-9_]*)|(__.*__))$ # ones are exempt. docstring-min-length=-1 -# Naming hint for function names -function-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct function names function-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ @@ -309,21 +284,12 @@ good-names=r,g,b,w,i,j,k,n,x,y,z,ex,ok,Run,_ # Include a hint for the correct naming format with invalid-name include-naming-hint=no -# Naming hint for inline iteration names -inlinevar-name-hint=[A-Za-z_][A-Za-z0-9_]*$ - # Regular expression matching correct inline iteration names inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$ -# Naming hint for method names -method-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct method names method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ -# Naming hint for module names -module-name-hint=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ - # Regular expression matching correct module names module-rgx=(([a-z_][a-z0-9_]*)|([A-Z][a-zA-Z0-9]+))$ @@ -339,9 +305,6 @@ no-docstring-rgx=^_ # to this list to register other decorators that produce valid properties. property-classes=abc.abstractproperty -# Naming hint for variable names -variable-name-hint=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ - # Regular expression matching correct variable names variable-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-z0-9_]*))$ From c1d9676f5acac8a0058ef24eba8628216dd1f692 Mon Sep 17 00:00:00 2001 From: dherrada Date: Fri, 18 Nov 2022 13:05:28 -0500 Subject: [PATCH 29/47] Added commented out board.STEMMA_I2C with explanation --- examples/pcf8591_adc_example.py | 3 ++- examples/pcf8591_analog_in.py | 3 ++- examples/pcf8591_dac_example.py | 3 ++- examples/pcf8591_simpletest.py | 3 ++- 4 files changed, 8 insertions(+), 4 deletions(-) diff --git a/examples/pcf8591_adc_example.py b/examples/pcf8591_adc_example.py index 72b3346..c7a809e 100644 --- a/examples/pcf8591_adc_example.py +++ b/examples/pcf8591_adc_example.py @@ -14,7 +14,8 @@ # normal power and I2C connections. The voltage level should be between 0V/GND and VCC # ######################################## -i2c = board.I2C() +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller pcf = PCF8591(i2c) channel_a = 0 diff --git a/examples/pcf8591_analog_in.py b/examples/pcf8591_analog_in.py index 7bb901f..0add4ba 100644 --- a/examples/pcf8591_analog_in.py +++ b/examples/pcf8591_analog_in.py @@ -18,7 +18,8 @@ # ######################################## -i2c = board.I2C() +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller pcf = PCF.PCF8591(i2c) pcf_in_0 = AnalogIn(pcf, PCF.A0) diff --git a/examples/pcf8591_dac_example.py b/examples/pcf8591_dac_example.py index 9f4ea7d..495f672 100644 --- a/examples/pcf8591_dac_example.py +++ b/examples/pcf8591_dac_example.py @@ -15,7 +15,8 @@ # normal power and I2C connections # ######################################## -i2c = board.I2C() +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller pcf = PCF8591(i2c) print("enabling DAC") diff --git a/examples/pcf8591_simpletest.py b/examples/pcf8591_simpletest.py index 05b4ade..6fc7ddf 100644 --- a/examples/pcf8591_simpletest.py +++ b/examples/pcf8591_simpletest.py @@ -18,7 +18,8 @@ # normal power and I2C connections # ##################################################################### -i2c = board.I2C() +i2c = board.I2C() # uses board.SCL and board.SDA +# i2c = board.STEMMA_I2C() # For using the built-in STEMMA QT connector on a microcontroller pcf = PCF.PCF8591(i2c) pcf_in_0 = AnalogIn(pcf, PCF.A0) From 9b09ba1a4f40656a96436ec1eb6578b1ea6b80aa Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 1 Sep 2022 20:16:31 -0400 Subject: [PATCH 30/47] Add .venv to .gitignore Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 544ec4a..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -37,6 +37,7 @@ _build # Virtual environment-specific files .env +.venv # MacOS-specific files *.DS_Store From 79f527c58815c7511db3ea3aa41ec87b96418e9f Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Thu, 19 Jan 2023 15:19:29 -0500 Subject: [PATCH 31/47] Add Missing Type Annotations --- adafruit_pcf8591/analog_in.py | 21 +++++++++++++-------- adafruit_pcf8591/analog_out.py | 15 +++++++++------ adafruit_pcf8591/pcf8591.py | 26 +++++++++++++++++++------- requirements.txt | 1 + 4 files changed, 42 insertions(+), 21 deletions(-) diff --git a/adafruit_pcf8591/analog_in.py b/adafruit_pcf8591/analog_in.py index 43a4824..8f57547 100644 --- a/adafruit_pcf8591/analog_in.py +++ b/adafruit_pcf8591/analog_in.py @@ -27,11 +27,16 @@ * Author(s): Bryan Siepert, adpted from ADS1x15 by Carter Nelson """ +try: + import typing # pylint: disable=unused-import +except ImportError: + pass + class AnalogIn: """AnalogIn Mock Implementation for ADC Reads.""" - def __init__(self, pcf, pin): + def __init__(self, pcf: "PCF8591", pin: int) -> None: """AnalogIn :param ads: The PCF8591 object. @@ -42,38 +47,38 @@ def __init__(self, pcf, pin): self._channel_number = pin @property - def voltage(self): + def voltage(self) -> float: """Returns the value of an ADC channel in volts as compared to the reference voltage.""" if not self._pcf: raise RuntimeError( - "Underlying ADC does not exist, likely due to callint `deinit`" + "Underlying ADC does not exist, likely due to calling `deinit`" ) raw_reading = self._pcf.read(self._channel_number) return ((raw_reading << 8) / 65535) * self._pcf.reference_voltage @property - def value(self): + def value(self) -> int: """Returns the value of an ADC channel. The value is scaled to a 16-bit integer from the native 8-bit value.""" if not self._pcf: raise RuntimeError( - "Underlying ADC does not exist, likely due to callint `deinit`" + "Underlying ADC does not exist, likely due to calling `deinit`" ) return self._pcf.read(self._channel_number) << 8 @property - def reference_voltage(self): + def reference_voltage(self) -> float: """The maximum voltage measurable (also known as the reference voltage) as a float in Volts. Assumed to be 3.3V but can be overridden using the `PCF8591` constructor""" if not self._pcf: raise RuntimeError( - "Underlying ADC does not exist, likely due to callint `deinit`" + "Underlying ADC does not exist, likely due to calling `deinit`" ) return self._pcf.reference_voltage - def deinit(self): + def deinit(self) -> None: """Release the reference to the PCF8591. Create a new AnalogIn to use it again.""" self._pcf = None diff --git a/adafruit_pcf8591/analog_out.py b/adafruit_pcf8591/analog_out.py index b90351e..dda0ce3 100644 --- a/adafruit_pcf8591/analog_out.py +++ b/adafruit_pcf8591/analog_out.py @@ -26,12 +26,15 @@ * Author(s): Bryan Siepert """ - +try: + import typing # pylint: disable=unused-import +except ImportError: + pass class AnalogOut: """AnalogIn Mock Implementation for ADC Reads.""" - def __init__(self, pcf, dac_pin=0): + def __init__(self, pcf: "PCF8591", dac_pin: int = 0) -> None: """AnalogIn :param pcf: The pcf object. @@ -45,24 +48,24 @@ def __init__(self, pcf, dac_pin=0): self._pcf.dac_enabled = True @property - def value(self): + def value(self) -> int: """Returns the currently set value of the DAC pin as an integer.""" return self._value @value.setter - def value(self, new_value): # this may have to scale from 16-bit + def value(self, new_value: int) -> None: # this may have to scale from 16-bit if new_value < 0 or new_value > 65535: raise ValueError("value must be a 16-bit integer from 0-65535") if not self._pcf.dac_enabled: raise RuntimeError( - "Underlying DAC is disabled, likely due to callint `deinit`" + "Underlying DAC is disabled, likely due to calling `deinit`" ) # underlying sensor is 8-bit, so scale accordingly self._pcf.write(new_value >> 8) self._value = new_value - def deinit(self): + def deinit(self) -> None: """Disable the underlying DAC and release the reference to the PCF8591. Create a new AnalogOut to use it again.""" self._pcf.dac_enabled = False diff --git a/adafruit_pcf8591/pcf8591.py b/adafruit_pcf8591/pcf8591.py index 741d429..184da83 100644 --- a/adafruit_pcf8591/pcf8591.py +++ b/adafruit_pcf8591/pcf8591.py @@ -33,6 +33,13 @@ from micropython import const from adafruit_bus_device import i2c_device +try: + import typing # pylint: disable=unused-import + from typing_extensions import Literal + from busio import I2C +except ImportError: + pass + _PCF8591_DEFAULT_ADDR = const(0x48) # PCF8591 Default Address _PCF8591_ENABLE_DAC = const(0x40) # control bit for having the DAC active @@ -53,7 +60,12 @@ class PCF8591: """ - def __init__(self, i2c_bus, address=_PCF8591_DEFAULT_ADDR, reference_voltage=3.3): + def __init__( + self, + i2c_bus: I2C, + address: int = _PCF8591_DEFAULT_ADDR, + reference_voltage: float = 3.3, + ) -> None: self.i2c_device = i2c_device.I2CDevice(i2c_bus, address) self._dacval = 0 self._dac_enabled = False @@ -67,12 +79,12 @@ def __init__(self, i2c_bus, address=_PCF8591_DEFAULT_ADDR, reference_voltage=3.3 # user calls to `read` @property - def reference_voltage(self): + def reference_voltage(self) -> float: """The voltage level that ADC signals are compared to. An ADC value of 65535 will equal `reference_voltage`""" return self._reference_voltage - def _half_read(self, channel): + def _half_read(self, channel: Literal[0, 1, 2, 3]) -> None: if self._dac_enabled: self._buffer[0] = _PCF8591_ENABLE_DAC self._buffer[1] = self._dacval @@ -85,7 +97,7 @@ def _half_read(self, channel): with self.i2c_device as i2c: i2c.write_then_readinto(self._buffer, self._buffer) - def read(self, channel): + def read(self, channel: Literal[0, 1, 2, 3]) -> None: """Read an analog value from one of the four ADC inputs param: :channel The single-ended ADC channel to read from, 0 thru 3 @@ -101,17 +113,17 @@ def read(self, channel): return unpack_from(">B", self._buffer[1:])[0] @property - def dac_enabled(self): + def dac_enabled(self) -> bool: """Enables the DAC when True, or sets it to tri-state / high-Z when False""" return self._dac_enabled @dac_enabled.setter - def dac_enabled(self, enable_dac): + def dac_enabled(self, enable_dac: bool) -> None: self._dac_enabled = enable_dac self.write(self._dacval) - def write(self, value): + def write(self, value: int) -> None: """Writes a uint8_t value to the DAC output param: :output The value to write: 0 is GND and 65535 is VCC diff --git a/requirements.txt b/requirements.txt index fcef575..6b8b435 100644 --- a/requirements.txt +++ b/requirements.txt @@ -5,3 +5,4 @@ Adafruit-Blinka adafruit-circuitpython-register adafruit-circuitpython-busdevice +typing-extensions~=4.0 From 7421e57642d632137e759d52bb20327d727735ed Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Thu, 19 Jan 2023 15:48:03 -0500 Subject: [PATCH 32/47] fix formatting in analog_out.py --- adafruit_pcf8591/analog_out.py | 1 + 1 file changed, 1 insertion(+) diff --git a/adafruit_pcf8591/analog_out.py b/adafruit_pcf8591/analog_out.py index dda0ce3..ece1021 100644 --- a/adafruit_pcf8591/analog_out.py +++ b/adafruit_pcf8591/analog_out.py @@ -31,6 +31,7 @@ except ImportError: pass + class AnalogOut: """AnalogIn Mock Implementation for ADC Reads.""" From 998c6eff080bd6ae4a725e6cb08ef2fcf5415043 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Thu, 19 Jan 2023 23:39:55 -0500 Subject: [PATCH 33/47] Add upload url to release action Signed-off-by: Alec Delaney <89490472+tekktrik@users.noreply.github.com> --- .github/workflows/release_gh.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml index b8aa8d6..9acec60 100644 --- a/.github/workflows/release_gh.yml +++ b/.github/workflows/release_gh.yml @@ -16,3 +16,4 @@ jobs: uses: adafruit/workflows-circuitpython-libs/release-gh@main with: github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} From 2a98a6957664d27ed20468b3d5e5ef1611e7675c Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Fri, 20 Jan 2023 11:00:56 -0500 Subject: [PATCH 34/47] changes per reviewer suggestions --- adafruit_pcf8591/analog_in.py | 7 ++++--- adafruit_pcf8591/analog_out.py | 5 +++-- adafruit_pcf8591/pcf8591.py | 2 +- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/adafruit_pcf8591/analog_in.py b/adafruit_pcf8591/analog_in.py index 8f57547..2c29012 100644 --- a/adafruit_pcf8591/analog_in.py +++ b/adafruit_pcf8591/analog_in.py @@ -29,6 +29,7 @@ try: import typing # pylint: disable=unused-import + from adafruit_pcf8591.pcf8591.PCF8591 import PCF8591 except ImportError: pass @@ -36,11 +37,11 @@ class AnalogIn: """AnalogIn Mock Implementation for ADC Reads.""" - def __init__(self, pcf: "PCF8591", pin: int) -> None: + def __init__(self, pcf: PCF8591, pin: int) -> None: """AnalogIn - :param ads: The PCF8591 object. - :param ~digitalio.DigitalInOut pin: Required ADC channel pin. + :param pcf: The PCF8591 object. + :param int pin: Required ADC channel pin. """ self._pcf = pcf diff --git a/adafruit_pcf8591/analog_out.py b/adafruit_pcf8591/analog_out.py index ece1021..ca762fc 100644 --- a/adafruit_pcf8591/analog_out.py +++ b/adafruit_pcf8591/analog_out.py @@ -28,6 +28,7 @@ """ try: import typing # pylint: disable=unused-import + from adafruit_pcf8591.pcf8591.PCF8591 import PCF8591 except ImportError: pass @@ -35,11 +36,11 @@ class AnalogOut: """AnalogIn Mock Implementation for ADC Reads.""" - def __init__(self, pcf: "PCF8591", dac_pin: int = 0) -> None: + def __init__(self, pcf: PCF8591, dac_pin: int = 0) -> None: """AnalogIn :param pcf: The pcf object. - :param ~digitalio.DigitalInOut DAC pin: Required pin must be P4 + :param int pin: Required pin must be A0 """ self._pcf = pcf diff --git a/adafruit_pcf8591/pcf8591.py b/adafruit_pcf8591/pcf8591.py index 184da83..aadfd03 100644 --- a/adafruit_pcf8591/pcf8591.py +++ b/adafruit_pcf8591/pcf8591.py @@ -100,7 +100,7 @@ def _half_read(self, channel: Literal[0, 1, 2, 3]) -> None: def read(self, channel: Literal[0, 1, 2, 3]) -> None: """Read an analog value from one of the four ADC inputs - param: :channel The single-ended ADC channel to read from, 0 thru 3 + param: int channel The single-ended ADC channel to read from, 0 thru 3 """ if channel < 0 or channel > 3: raise ValueError("channel must be from 0-3") From 900c1d1d42dde4f256eabce28f9148a8dd8caa8e Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Fri, 20 Jan 2023 13:12:34 -0500 Subject: [PATCH 35/47] changes per additional reviewer suggestions --- adafruit_pcf8591/analog_out.py | 2 +- adafruit_pcf8591/pcf8591.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_pcf8591/analog_out.py b/adafruit_pcf8591/analog_out.py index ca762fc..1118342 100644 --- a/adafruit_pcf8591/analog_out.py +++ b/adafruit_pcf8591/analog_out.py @@ -40,7 +40,7 @@ def __init__(self, pcf: PCF8591, dac_pin: int = 0) -> None: """AnalogIn :param pcf: The pcf object. - :param int pin: Required pin must be A0 + :param adafruit_pcf8591.pcf8591.A0 pin: Required pin must be A0 """ self._pcf = pcf diff --git a/adafruit_pcf8591/pcf8591.py b/adafruit_pcf8591/pcf8591.py index aadfd03..894e376 100644 --- a/adafruit_pcf8591/pcf8591.py +++ b/adafruit_pcf8591/pcf8591.py @@ -100,7 +100,7 @@ def _half_read(self, channel: Literal[0, 1, 2, 3]) -> None: def read(self, channel: Literal[0, 1, 2, 3]) -> None: """Read an analog value from one of the four ADC inputs - param: int channel The single-ended ADC channel to read from, 0 thru 3 + param: int channel: The single-ended ADC channel to read from, 0 thru 3 """ if channel < 0 or channel > 3: raise ValueError("channel must be from 0-3") From 09ffedafe3003a7e178edde11be29502e8ceb52b Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Mon, 23 Jan 2023 16:06:42 -0500 Subject: [PATCH 36/47] fixes to multiple docstring param statements --- adafruit_pcf8591/pcf8591.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/adafruit_pcf8591/pcf8591.py b/adafruit_pcf8591/pcf8591.py index 894e376..a3aafb0 100644 --- a/adafruit_pcf8591/pcf8591.py +++ b/adafruit_pcf8591/pcf8591.py @@ -56,7 +56,7 @@ class PCF8591: """Driver for the PCF8591 DAC & ADC Combo breakout. :param ~busio.I2C i2c_bus: The I2C bus the PCF8591 is connected to. - :param address: The I2C device address for the sensor. Default is ``0x28``. + :param int address: The I2C device address for the sensor. Default is ``0x28``. """ @@ -100,7 +100,7 @@ def _half_read(self, channel: Literal[0, 1, 2, 3]) -> None: def read(self, channel: Literal[0, 1, 2, 3]) -> None: """Read an analog value from one of the four ADC inputs - param: int channel: The single-ended ADC channel to read from, 0 thru 3 + :param int channel: The single-ended ADC channel to read from, 0 thru 3 """ if channel < 0 or channel > 3: raise ValueError("channel must be from 0-3") @@ -126,7 +126,7 @@ def dac_enabled(self, enable_dac: bool) -> None: def write(self, value: int) -> None: """Writes a uint8_t value to the DAC output - param: :output The value to write: 0 is GND and 65535 is VCC + :param int value: The value to write: 0 is GND and 65535 is VCC """ From b369e496b8a981b8340c8886b9913784a3c75a3c Mon Sep 17 00:00:00 2001 From: Thomas Franks Date: Tue, 24 Jan 2023 09:44:44 -0500 Subject: [PATCH 37/47] change to analog_out param pin --- adafruit_pcf8591/analog_out.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_pcf8591/analog_out.py b/adafruit_pcf8591/analog_out.py index 1118342..348f0a2 100644 --- a/adafruit_pcf8591/analog_out.py +++ b/adafruit_pcf8591/analog_out.py @@ -40,7 +40,7 @@ def __init__(self, pcf: PCF8591, dac_pin: int = 0) -> None: """AnalogIn :param pcf: The pcf object. - :param adafruit_pcf8591.pcf8591.A0 pin: Required pin must be A0 + :param int pin: Required pin must be adafruit_pcf8591.pcf8591.A0 """ self._pcf = pcf From 15db2111d9592e45248d006883195cfd120ba96f Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Tue, 9 May 2023 20:26:25 -0400 Subject: [PATCH 38/47] Update pre-commit hooks Signed-off-by: Tekktrik --- .pre-commit-config.yaml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 0e5fccc..70ade69 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -4,21 +4,21 @@ repos: - repo: https://github.com/python/black - rev: 22.3.0 + rev: 23.3.0 hooks: - id: black - repo: https://github.com/fsfe/reuse-tool - rev: v0.14.0 + rev: v1.1.2 hooks: - id: reuse - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.2.0 + rev: v4.4.0 hooks: - id: check-yaml - id: end-of-file-fixer - id: trailing-whitespace - repo: https://github.com/pycqa/pylint - rev: v2.15.5 + rev: v2.17.4 hooks: - id: pylint name: pylint (library code) From 7a217f6875e32c3e9fd324538a4f58170cb85040 Mon Sep 17 00:00:00 2001 From: Tekktrik Date: Wed, 10 May 2023 22:41:12 -0400 Subject: [PATCH 39/47] Run pre-commit --- adafruit_pcf8591/analog_in.py | 3 ++- adafruit_pcf8591/pcf8591.py | 1 - examples/pcf8591_adc_example.py | 1 - examples/pcf8591_simpletest.py | 1 - 4 files changed, 2 insertions(+), 4 deletions(-) diff --git a/adafruit_pcf8591/analog_in.py b/adafruit_pcf8591/analog_in.py index 2c29012..e9023c8 100644 --- a/adafruit_pcf8591/analog_in.py +++ b/adafruit_pcf8591/analog_in.py @@ -73,7 +73,8 @@ def value(self) -> int: @property def reference_voltage(self) -> float: """The maximum voltage measurable (also known as the reference voltage) as a float in - Volts. Assumed to be 3.3V but can be overridden using the `PCF8591` constructor""" + Volts. Assumed to be 3.3V but can be overridden using the `PCF8591` constructor + """ if not self._pcf: raise RuntimeError( "Underlying ADC does not exist, likely due to calling `deinit`" diff --git a/adafruit_pcf8591/pcf8591.py b/adafruit_pcf8591/pcf8591.py index a3aafb0..a2c798d 100644 --- a/adafruit_pcf8591/pcf8591.py +++ b/adafruit_pcf8591/pcf8591.py @@ -119,7 +119,6 @@ def dac_enabled(self) -> bool: @dac_enabled.setter def dac_enabled(self, enable_dac: bool) -> None: - self._dac_enabled = enable_dac self.write(self._dacval) diff --git a/examples/pcf8591_adc_example.py b/examples/pcf8591_adc_example.py index c7a809e..315a7e1 100644 --- a/examples/pcf8591_adc_example.py +++ b/examples/pcf8591_adc_example.py @@ -22,7 +22,6 @@ channel_b = 1 while True: - read_value = pcf.read(channel_a) scaled_value = (read_value / 255) * pcf.reference_voltage diff --git a/examples/pcf8591_simpletest.py b/examples/pcf8591_simpletest.py index 6fc7ddf..73c380a 100644 --- a/examples/pcf8591_simpletest.py +++ b/examples/pcf8591_simpletest.py @@ -26,7 +26,6 @@ pcf_out = AnalogOut(pcf, PCF.OUT) while True: - print("Setting out to ", 65535) pcf_out.value = 65535 raw_value = pcf_in_0.value From 334a5d9eb137e5d3cd77b5167e056e89b3bf811e Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 10:58:05 -0400 Subject: [PATCH 40/47] Fix typing imports --- adafruit_pcf8591/analog_in.py | 2 +- adafruit_pcf8591/analog_out.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/adafruit_pcf8591/analog_in.py b/adafruit_pcf8591/analog_in.py index e9023c8..8a651e8 100644 --- a/adafruit_pcf8591/analog_in.py +++ b/adafruit_pcf8591/analog_in.py @@ -29,7 +29,7 @@ try: import typing # pylint: disable=unused-import - from adafruit_pcf8591.pcf8591.PCF8591 import PCF8591 + from adafruit_pcf8591.pcf8591 import PCF8591 except ImportError: pass diff --git a/adafruit_pcf8591/analog_out.py b/adafruit_pcf8591/analog_out.py index 348f0a2..f1d41c8 100644 --- a/adafruit_pcf8591/analog_out.py +++ b/adafruit_pcf8591/analog_out.py @@ -28,7 +28,7 @@ """ try: import typing # pylint: disable=unused-import - from adafruit_pcf8591.pcf8591.PCF8591 import PCF8591 + from adafruit_pcf8591.pcf8591 import PCF8591 except ImportError: pass From 5026e795a6fd353ddfe3289d71a7ddee6daf046e Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 11:02:57 -0400 Subject: [PATCH 41/47] Update existing annotations --- adafruit_pcf8591/analog_in.py | 5 +++-- adafruit_pcf8591/analog_out.py | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/adafruit_pcf8591/analog_in.py b/adafruit_pcf8591/analog_in.py index 8a651e8..8a9725f 100644 --- a/adafruit_pcf8591/analog_in.py +++ b/adafruit_pcf8591/analog_in.py @@ -29,6 +29,7 @@ try: import typing # pylint: disable=unused-import + from typing_extensions import Literal from adafruit_pcf8591.pcf8591 import PCF8591 except ImportError: pass @@ -37,11 +38,11 @@ class AnalogIn: """AnalogIn Mock Implementation for ADC Reads.""" - def __init__(self, pcf: PCF8591, pin: int) -> None: + def __init__(self, pcf: PCF8591, pin: Literal[0, 1, 2, 3]) -> None: """AnalogIn :param pcf: The PCF8591 object. - :param int pin: Required ADC channel pin. + :param int pin: Required ADC channel pin; must be 0-3 inclusive """ self._pcf = pcf diff --git a/adafruit_pcf8591/analog_out.py b/adafruit_pcf8591/analog_out.py index f1d41c8..428627b 100644 --- a/adafruit_pcf8591/analog_out.py +++ b/adafruit_pcf8591/analog_out.py @@ -28,6 +28,7 @@ """ try: import typing # pylint: disable=unused-import + from typing_extensions import Literal from adafruit_pcf8591.pcf8591 import PCF8591 except ImportError: pass @@ -36,11 +37,11 @@ class AnalogOut: """AnalogIn Mock Implementation for ADC Reads.""" - def __init__(self, pcf: PCF8591, dac_pin: int = 0) -> None: + def __init__(self, pcf: PCF8591, dac_pin: Literal[0] = 0) -> None: """AnalogIn :param pcf: The pcf object. - :param int pin: Required pin must be adafruit_pcf8591.pcf8591.A0 + :param int dac_pin: Required pin must be adafruit_pcf8591.pcf8591.A0 """ self._pcf = pcf From 1552eabb4c4cf840897cf2d78e9aa10348baec60 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 11:05:11 -0400 Subject: [PATCH 42/47] Correction annotation for PCF8591.read() --- adafruit_pcf8591/pcf8591.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/adafruit_pcf8591/pcf8591.py b/adafruit_pcf8591/pcf8591.py index a2c798d..96aef52 100644 --- a/adafruit_pcf8591/pcf8591.py +++ b/adafruit_pcf8591/pcf8591.py @@ -97,7 +97,7 @@ def _half_read(self, channel: Literal[0, 1, 2, 3]) -> None: with self.i2c_device as i2c: i2c.write_then_readinto(self._buffer, self._buffer) - def read(self, channel: Literal[0, 1, 2, 3]) -> None: + def read(self, channel: Literal[0, 1, 2, 3]) -> int: """Read an analog value from one of the four ADC inputs :param int channel: The single-ended ADC channel to read from, 0 thru 3 From 12f316dca28d857ba099b652eeed7772f54f69f3 Mon Sep 17 00:00:00 2001 From: Alec Delaney <89490472+tekktrik@users.noreply.github.com> Date: Tue, 23 May 2023 23:56:01 -0400 Subject: [PATCH 43/47] Update .pylintrc, fix jQuery for docs --- .pylintrc | 2 +- docs/conf.py | 1 + docs/requirements.txt | 1 + 3 files changed, 3 insertions(+), 1 deletion(-) diff --git a/.pylintrc b/.pylintrc index 40208c3..f945e92 100644 --- a/.pylintrc +++ b/.pylintrc @@ -396,4 +396,4 @@ min-public-methods=1 # Exceptions that will emit a warning when being caught. Defaults to # "Exception" -overgeneral-exceptions=Exception +overgeneral-exceptions=builtins.Exception diff --git a/docs/conf.py b/docs/conf.py index 9b7f4ee..3d878f7 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -17,6 +17,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..797aa04 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -3,3 +3,4 @@ # SPDX-License-Identifier: Unlicense sphinx>=4.0.0 +sphinxcontrib-jquery From 6c94e2d7a910b43dd70cb9716662b491563fa550 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 18 Sep 2023 16:45:40 -0500 Subject: [PATCH 44/47] fix rtd theme --- docs/conf.py | 17 ++++------------- 1 file changed, 4 insertions(+), 13 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 3d878f7..d140706 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -115,19 +115,10 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -on_rtd = os.environ.get("READTHEDOCS", None) == "True" - -if not on_rtd: # only import and set the theme if we're building docs locally - try: - import sphinx_rtd_theme - - html_theme = "sphinx_rtd_theme" - html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] - except: - html_theme = "default" - html_theme_path = ["."] -else: - html_theme_path = ["."] +import sphinx_rtd_theme + +html_theme = "sphinx_rtd_theme" +html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From a8672200b7a451883a97e6021cad5620c2777b33 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 4 Dec 2023 11:37:39 -0600 Subject: [PATCH 45/47] unpin sphinx and add sphinx-rtd-theme to docs reqs --- docs/requirements.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 797aa04..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,5 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx sphinxcontrib-jquery +sphinx-rtd-theme From cf5059fa04c22f8a2f008f73ebdf48d1abb394e7 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Mon, 7 Oct 2024 09:24:05 -0500 Subject: [PATCH 46/47] remove deprecated get_html_theme_path() call Signed-off-by: foamyguy --- docs/conf.py | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index d140706..4438571 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -118,7 +118,6 @@ import sphinx_rtd_theme html_theme = "sphinx_rtd_theme" -html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, From a15af75c1124a5a37074e0aebc1106e1be7fa7d4 Mon Sep 17 00:00:00 2001 From: foamyguy Date: Tue, 14 Jan 2025 11:32:34 -0600 Subject: [PATCH 47/47] add sphinx configuration to rtd.yaml Signed-off-by: foamyguy --- .readthedocs.yaml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..88bca9f 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,6 +8,9 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: os: ubuntu-20.04 tools: