diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..21c125c --- /dev/null +++ b/.gitattributes @@ -0,0 +1,11 @@ +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries +# +# SPDX-License-Identifier: Unlicense + +.py text eol=lf +.rst text eol=lf +.txt text eol=lf +.yaml text eol=lf +.toml text eol=lf +.license text eol=lf +.md text eol=lf diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 474520d..041a337 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -10,66 +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: 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 setup.py - id: need-pypi - run: | - echo ::set-output name=setup-py::$( find . -wholename './setup.py' ) - - name: Build Python package - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - pip install --upgrade setuptools wheel twine readme_renderer testresources - python setup.py sdist - python setup.py bdist_wheel --universal - twine check dist/* - - name: Setup problem matchers - uses: adafruit/circuitpython-action-library-ci-problem-matchers@v1 + - 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 a65e5de..0000000 --- a/.github/workflows/release.yml +++ /dev/null @@ -1,85 +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 setup.py - id: need-pypi - run: | - 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@v2 - with: - python-version: '3.x' - - name: Install dependencies - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - run: | - python -m pip install --upgrade pip - pip install setuptools wheel twine - - name: Build and publish - if: contains(steps.need-pypi.outputs.setup-py, 'setup.py') - env: - TWINE_USERNAME: ${{ secrets.pypi_username }} - TWINE_PASSWORD: ${{ secrets.pypi_password }} - run: | - python setup.py sdist - twine upload dist/* diff --git a/.github/workflows/release_gh.yml b/.github/workflows/release_gh.yml new file mode 100644 index 0000000..9acec60 --- /dev/null +++ b/.github/workflows/release_gh.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: GitHub Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - name: Run GitHub Release CI workflow + uses: adafruit/workflows-circuitpython-libs/release-gh@main + with: + github-token: ${{ secrets.GITHUB_TOKEN }} + upload-url: ${{ github.event.release.upload_url }} diff --git a/.github/workflows/release_pypi.yml b/.github/workflows/release_pypi.yml new file mode 100644 index 0000000..65775b7 --- /dev/null +++ b/.github/workflows/release_pypi.yml @@ -0,0 +1,19 @@ +# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +name: PyPI Release Actions + +on: + release: + types: [published] + +jobs: + upload-release-assets: + runs-on: ubuntu-latest + steps: + - 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 }} 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 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 29230db..ff19dde 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -1,42 +1,21 @@ -# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò +# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries # # SPDX-License-Identifier: Unlicense repos: -- repo: https://github.com/python/black - rev: 22.3.0 + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 hooks: - - id: black -- repo: https://github.com/fsfe/reuse-tool - rev: v0.12.1 + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + - repo: https://github.com/astral-sh/ruff-pre-commit + rev: v0.3.4 hooks: - - id: reuse -- repo: https://github.com/pre-commit/pre-commit-hooks - rev: v2.3.0 + - id: ruff-format + - id: ruff + args: ["--fix"] + - repo: https://github.com/fsfe/reuse-tool + rev: v3.0.1 hooks: - - id: check-yaml - - id: end-of-file-fixer - - id: trailing-whitespace -- repo: https://github.com/pycqa/pylint - rev: v2.11.1 - hooks: - - id: pylint - name: pylint (library code) - types: [python] - args: - - --disable=consider-using-f-string,duplicate-code - exclude: "^(docs/|examples/|tests/|setup.py$)" - - 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 - 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 + - id: reuse diff --git a/.pylintrc b/.pylintrc deleted file mode 100644 index cfd1c41..0000000 --- a/.pylintrc +++ /dev/null @@ -1,436 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -[MASTER] - -# A comma-separated list of package or module names from where C extensions may -# be loaded. Extensions are loading into the active Python interpreter and may -# run arbitrary code -extension-pkg-whitelist= - -# Add files or directories to the blacklist. They should be base names, not -# paths. -ignore=CVS - -# Add files or directories matching the regex patterns to the blacklist. The -# regex matches against base names, not paths. -ignore-patterns= - -# Python code to execute, usually for sys.path manipulation such as -# pygtk.require(). -#init-hook= - -# Use multiple processes to speed up Pylint. -jobs=1 - -# List of plugins (as comma separated values of python modules names) to load, -# usually to register additional checkers. -load-plugins= - -# Pickle collected data for later comparisons. -persistent=yes - -# Specify a configuration file. -#rcfile= - -# Allow loading of arbitrary C extensions. Extensions are imported into the -# active Python interpreter and may run arbitrary code. -unsafe-load-any-extension=no - - -[MESSAGES CONTROL] - -# Only show warnings with the listed confidence levels. Leave empty to show -# all. Valid levels: HIGH, INFERENCE, INFERENCE_FAILURE, UNDEFINED -confidence= - -# Disable the message, report, category or checker with the given id(s). You -# can either give multiple identifiers separated by comma (,) or put this -# option multiple times (only on the command line, not in the configuration -# file where it should appear only once).You can also use "--disable=all" to -# disable everything first and then reenable specific checks. For example, if -# you want to run only the similarities checker, you can use "--disable=all -# --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 - -# 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 -# multiple time (only on the command line, not in the configuration file where -# it should appear only once). See also the "--disable" option for examples. -enable= - - -[REPORTS] - -# Python expression which should return a note less than 10 (10 is the highest -# note). You have access to the variables errors warning, statement which -# respectively contain the number of errors / warnings messages and the total -# number of statements analyzed. This is used by the global evaluation report -# (RP0004). -evaluation=10.0 - ((float(5 * error + warning + refactor + convention) / statement) * 10) - -# Template used to display messages. This is a python new-style format string -# used to format the message information. See doc for all details -#msg-template= - -# Set the output format. Available formats are text, parseable, colorized, json -# and msvs (visual studio).You can also give a reporter class, eg -# mypackage.mymodule.MyReporterClass. -output-format=text - -# Tells whether to display a full report or only the messages -reports=no - -# Activate the evaluation score. -score=yes - - -[REFACTORING] - -# Maximum number of nested blocks for function / method body -max-nested-blocks=5 - - -[LOGGING] - -# Logging modules to check that the string format arguments are in logging -# function parameter format -logging-modules=logging - - -[SPELLING] - -# Spelling dictionary name. Available dictionaries: none. To make it working -# install python-enchant package. -spelling-dict= - -# List of comma separated words that should not be checked. -spelling-ignore-words= - -# A path to a file that contains private dictionary; one word per line. -spelling-private-dict-file= - -# Tells whether to store unknown words to indicated private dictionary in -# --spelling-private-dict-file option instead of raising a message. -spelling-store-unknown-words=no - - -[MISCELLANEOUS] - -# List of note tags to take in consideration, separated by a comma. -# notes=FIXME,XXX,TODO -notes=FIXME,XXX - - -[TYPECHECK] - -# List of decorators that produce context managers, such as -# contextlib.contextmanager. Add to this list to register other decorators that -# produce valid context managers. -contextmanager-decorators=contextlib.contextmanager - -# List of members which are set dynamically and missed by pylint inference -# system, and so shouldn't trigger E1101 when accessed. Python regular -# expressions are accepted. -generated-members= - -# Tells whether missing members accessed in mixin class should be ignored. A -# mixin class is detected if its name ends with "mixin" (case insensitive). -ignore-mixin-members=yes - -# This flag controls whether pylint should warn about no-member and similar -# checks whenever an opaque object is returned when inferring. The inference -# can return multiple potential results while evaluating a Python object, but -# some branches might not be evaluated, which results in partial inference. In -# that case, it might be useful to still emit no-member and other checks for -# the rest of the inferred objects. -ignore-on-opaque-inference=yes - -# List of class names for which member attributes should not be checked (useful -# for classes with dynamically set attributes). This supports the use of -# qualified names. -ignored-classes=optparse.Values,thread._local,_thread._local - -# List of module names for which member attributes should not be checked -# (useful for modules/projects where namespaces are manipulated during runtime -# and thus existing member attributes cannot be deduced by static analysis. It -# supports qualified module names, as well as Unix pattern matching. -ignored-modules=board - -# Show a hint with possible names when a member name was not found. The aspect -# of finding the hint is based on edit distance. -missing-member-hint=yes - -# The minimum edit distance a name should have in order to be considered a -# similar match for a missing member name. -missing-member-hint-distance=1 - -# The total number of similar names that should be taken in consideration when -# showing a hint for a missing member. -missing-member-max-choices=1 - - -[VARIABLES] - -# List of additional names supposed to be defined in builtins. Remember that -# you should avoid to define new builtins when possible. -additional-builtins= - -# Tells whether unused global variables should be treated as a violation. -allow-global-unused-variables=yes - -# List of strings which can identify a callback function by name. A callback -# name must start or end with one of those strings. -callbacks=cb_,_cb - -# A regular expression matching the name of dummy variables (i.e. expectedly -# not used). -dummy-variables-rgx=_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_ - -# Argument names that match this expression will be ignored. Default to name -# with leading underscore -ignored-argument-names=_.*|^ignored_|^unused_ - -# Tells whether we should check for unused import in __init__ files. -init-import=no - -# List of qualified module names which can have objects that can redefine -# builtins. -redefining-builtins-modules=six.moves,future.builtins - - -[FORMAT] - -# Expected format of line ending, e.g. empty (any line ending), LF or CRLF. -# expected-line-ending-format= -expected-line-ending-format=LF - -# Regexp for a line that is allowed to be longer than the limit. -ignore-long-lines=^\s*(# )??$ - -# Number of spaces of indent required inside a hanging or continued line. -indent-after-paren=4 - -# String used as indentation unit. This is usually " " (4 spaces) or "\t" (1 -# tab). -indent-string=' ' - -# Maximum number of characters on a single line. -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 - -# Allow the body of an if to be on the same line as the test if there is no -# else. -single-line-if-stmt=no - - -[SIMILARITIES] - -# Ignore comments when computing similarities. -ignore-comments=yes - -# Ignore docstrings when computing similarities. -ignore-docstrings=yes - -# Ignore imports when computing similarities. -ignore-imports=yes - -# Minimum lines number of a similarity. -min-similarity-lines=4 - - -[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_]*)|(__.*__))$ - -# Minimum line length for functions/classes that require docstrings, shorter -# 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_]*))$ - -# Good variable names which should always be accepted, separated by a comma -# good-names=i,j,k,ex,Run,_ -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]+))$ - -# Colon-delimited sets of names that determine each other's naming style when -# the name regexes allow several styles. -name-group= - -# Regular expression which should only match function or class names that do -# not require a docstring. -no-docstring-rgx=^_ - -# List of decorators that produce properties, such as abc.abstractproperty. Add -# 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_]*))$ - - -[IMPORTS] - -# Allow wildcard imports from modules that define __all__. -allow-wildcard-with-all=no - -# Analyse import fallback blocks. This can be used to support both Python 2 and -# 3 compatible code, which means that the block might have code that exists -# only in one or another interpreter, leading to false positives when analysed. -analyse-fallback-blocks=no - -# Deprecated modules which should not be used, separated by a comma -deprecated-modules=optparse,tkinter.tix - -# Create a graph of external dependencies in the given file (report RP0402 must -# not be disabled) -ext-import-graph= - -# Create a graph of every (i.e. internal and external) dependencies in the -# given file (report RP0402 must not be disabled) -import-graph= - -# Create a graph of internal dependencies in the given file (report RP0402 must -# not be disabled) -int-import-graph= - -# Force import order to recognize a module as part of the standard -# compatibility libraries. -known-standard-library= - -# Force import order to recognize a module as part of a third party library. -known-third-party=enchant - - -[CLASSES] - -# List of method names used to declare (i.e. assign) instance attributes. -defining-attr-methods=__init__,__new__,setUp - -# List of member names, which should be excluded from the protected access -# warning. -exclude-protected=_asdict,_fields,_replace,_source,_make - -# List of valid names for the first argument in a class method. -valid-classmethod-first-arg=cls - -# List of valid names for the first argument in a metaclass class method. -valid-metaclass-classmethod-first-arg=mcs - - -[DESIGN] - -# Maximum number of arguments for function / method -max-args=5 - -# Maximum number of attributes for a class (see R0902). -# max-attributes=7 -max-attributes=11 - -# Maximum number of boolean expressions in a if statement -max-bool-expr=5 - -# Maximum number of branch for function / method body -max-branches=12 - -# Maximum number of locals for function / method body -max-locals=15 - -# Maximum number of parents for a class (see R0901). -max-parents=7 - -# Maximum number of public methods for a class (see R0904). -max-public-methods=20 - -# Maximum number of return / yield for function / method body -max-returns=6 - -# Maximum number of statements in function / method body -max-statements=50 - -# Minimum number of public methods for a class (see R0903). -min-public-methods=1 - - -[EXCEPTIONS] - -# Exceptions that will emit a warning when being caught. Defaults to -# "Exception" -overgeneral-exceptions=Exception diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 33c2a61..255dafd 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -8,8 +8,11 @@ # Required version: 2 +sphinx: + configuration: docs/conf.py + build: - os: ubuntu-20.04 + os: ubuntu-lts-latest tools: python: "3" diff --git a/README.rst b/README.rst index 7bd2813..811883b 100644 --- a/README.rst +++ b/README.rst @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_PyBadger/actions/ :alt: Build Status +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json + :target: https://github.com/astral-sh/ruff + :alt: Code Style: Ruff + Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer, CLUE, and Mag Tag. @@ -46,8 +50,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-pybadger Usage Example diff --git a/adafruit_pybadger/clue.py b/adafruit_pybadger/clue.py index e49180b..f99e14a 100644 --- a/adafruit_pybadger/clue.py +++ b/adafruit_pybadger/clue.py @@ -26,23 +26,21 @@ """ from collections import namedtuple -import board + +import adafruit_lsm6ds.lsm6ds3trc +import adafruit_lsm6ds.lsm6ds33 import audiopwmio +import board import keypad -import adafruit_lsm6ds.lsm6ds33 import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -__version__ = "0.0.0-auto.0" +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase + +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "a b") -try: - from typing import Type -except ImportError: - pass - class Clue(PyBadgerBase): """Class that represents a single CLUE.""" @@ -56,7 +54,10 @@ def __init__(self) -> None: i2c = board.I2C() if i2c is not None: - self._accelerometer = adafruit_lsm6ds.lsm6ds33.LSM6DS33(i2c) + try: + self._accelerometer = adafruit_lsm6ds.lsm6ds33.LSM6DS33(i2c) + except RuntimeError: + self._accelerometer = adafruit_lsm6ds.lsm6ds3trc.LSM6DS3TRC(i2c) # NeoPixels self._neopixels = neopixel.NeoPixel( @@ -69,7 +70,7 @@ def __init__(self) -> None: self._buttons = KeyStates(self._keys) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: @@ -85,9 +86,7 @@ def button(self) -> Type[tuple]: print("Button B") """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons(button_values[0], button_values[1]) @property @@ -102,5 +101,5 @@ def _unsupported(self): light = _unsupported -clue = Clue() # pylint: disable=invalid-name +clue = Clue() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/cpb_gizmo.py b/adafruit_pybadger/cpb_gizmo.py index 5d205c7..dffdab7 100644 --- a/adafruit_pybadger/cpb_gizmo.py +++ b/adafruit_pybadger/cpb_gizmo.py @@ -27,23 +27,20 @@ """ from collections import namedtuple -import board -import digitalio + +import adafruit_lis3dh import analogio -import busio import audiopwmio +import board +import busio +import digitalio import keypad -from adafruit_gizmo import tft_gizmo -import adafruit_lis3dh import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +from adafruit_gizmo import tft_gizmo -try: - from typing import Type -except ImportError: - pass +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "a b") @@ -79,7 +76,7 @@ def __init__(self) -> None: self._light_sensor = analogio.AnalogIn(board.LIGHT) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: @@ -95,9 +92,7 @@ def button(self) -> Type[tuple]: print("Button B") """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons(button_values[0], button_values[1]) @property @@ -110,5 +105,5 @@ def _unsupported(self): # NotImplementedError raised in the property above. -cpb_gizmo = CPB_Gizmo() # pylint: disable=invalid-name +cpb_gizmo = CPB_Gizmo() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/magtag.py b/adafruit_pybadger/magtag.py index 77415bb..0f3251c 100644 --- a/adafruit_pybadger/magtag.py +++ b/adafruit_pybadger/magtag.py @@ -26,16 +26,13 @@ """ from collections import namedtuple + import board import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase -try: - from typing import Type -except ImportError: - pass +from adafruit_pybadger.pybadger_base import PyBadgerBase -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "a b c d") @@ -55,7 +52,7 @@ def __init__(self) -> None: ) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: @@ -85,5 +82,5 @@ def _unsupported(self): button = _unsupported -magtag = MagTag() # pylint: disable=invalid-name +magtag = MagTag() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pewpewm4.py b/adafruit_pybadger/pewpewm4.py index 6fa95fc..cd8f3cd 100644 --- a/adafruit_pybadger/pewpewm4.py +++ b/adafruit_pybadger/pewpewm4.py @@ -26,17 +26,14 @@ """ from collections import namedtuple -import board + import audioio +import board import keypad -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -try: - from typing import Type -except ImportError: - pass +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", ("o", "x", "z", "right", "down", "up", "left")) @@ -68,7 +65,7 @@ def __init__(self) -> None: self._buttons = KeyStates(self._keys) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: @@ -84,9 +81,7 @@ def button(self) -> Type[tuple]: print("Button O") """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons( button_values[0], button_values[1], @@ -110,5 +105,5 @@ def _unsupported(self): pixels = _unsupported -pewpewm4 = PewPewM4() # pylint: disable=invalid-name +pewpewm4 = PewPewM4() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pybadge.py b/adafruit_pybadger/pybadge.py index a90b3e1..312750a 100644 --- a/adafruit_pybadger/pybadge.py +++ b/adafruit_pybadger/pybadge.py @@ -31,21 +31,18 @@ """ from collections import namedtuple -import board -import digitalio + +import adafruit_lis3dh import analogio import audioio +import board +import digitalio import keypad -import adafruit_lis3dh import neopixel -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates -try: - from typing import Type -except ImportError: - pass +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "b a start select right down up left") @@ -79,12 +76,10 @@ def __init__(self) -> None: break # PyBadge LC doesn't have accelerometer - if int(0x18) in _i2c_devices or int(0x19) in _i2c_devices: + if 0x18 in _i2c_devices or 0x19 in _i2c_devices: int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) try: - self._accelerometer = adafruit_lis3dh.LIS3DH_I2C( - i2c, address=0x19, int1=int1 - ) + self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1) except ValueError: self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) @@ -105,7 +100,7 @@ def __init__(self) -> None: self._light_sensor = analogio.AnalogIn(board.A7) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: @@ -126,9 +121,7 @@ def button(self) -> Type[tuple]: """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) return Buttons( button_values[0], button_values[1], @@ -141,5 +134,5 @@ def button(self) -> Type[tuple]: ) -pybadge = PyBadge() # pylint: disable=invalid-name +pybadge = PyBadge() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pybadger_base.py b/adafruit_pybadger/pybadger_base.py index c7d280c..67f4443 100644 --- a/adafruit_pybadger/pybadger_base.py +++ b/adafruit_pybadger/pybadger_base.py @@ -29,19 +29,19 @@ from __future__ import annotations - -import time import array import math +import time + +import adafruit_miniqr import board -from micropython import const import digitalio -from adafruit_bitmap_font import bitmap_font import displayio +import terminalio +from adafruit_bitmap_font import bitmap_font from adafruit_display_shapes.rect import Rect from adafruit_display_text import bitmap_label as label -import terminalio -import adafruit_miniqr +from micropython import const AUDIO_ENABLED = False try: @@ -63,15 +63,16 @@ TYPE_CHECKING = const(0) if TYPE_CHECKING: - from typing import Union, Tuple, Optional, Generator - from adafruit_bitmap_font.bdf import BDF # pylint: disable=ungrouped-imports - from adafruit_bitmap_font.pcf import PCF # pylint: disable=ungrouped-imports + from typing import Generator, Optional, Union + + from adafruit_bitmap_font.bdf import BDF + from adafruit_bitmap_font.pcf import PCF from fontio import BuiltinFont from keypad import Keys, ShiftRegisterKeys from neopixel import NeoPixel -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -87,7 +88,6 @@ def load_font(fontname: str, text: str) -> Union[BDF, PCF]: return font -# pylint: disable=too-many-instance-attributes class PyBadgerBase: """PyBadger base class.""" @@ -165,13 +165,10 @@ def _create_badge_background(self) -> None: if self._background_group is None: self._background_group = displayio.Group() - self.show(self._background_group) + self.root_group = self._background_group if self._background_image_filename: - file_handle = open( # pylint: disable=consider-using-with - self._background_image_filename, "rb" - ) - on_disk_bitmap = displayio.OnDiskBitmap(file_handle) + on_disk_bitmap = displayio.OnDiskBitmap(self._background_image_filename) background_image = displayio.TileGrid( on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader, @@ -182,8 +179,8 @@ def _create_badge_background(self) -> None: def badge_background( self, - background_color: Tuple[int, int, int] = RED, - rectangle_color: Tuple[int, int, int] = WHITE, + background_color: tuple[int, int, int] = RED, + rectangle_color: tuple[int, int, int] = WHITE, rectangle_drop: float = 0.4, rectangle_height: float = 0.5, ) -> displayio.Group: @@ -219,8 +216,8 @@ def badge_background( def _badge_background( self, - background_color: Tuple[int, int, int] = RED, - rectangle_color: Tuple[int, int, int] = WHITE, + background_color: tuple[int, int, int] = RED, + rectangle_color: tuple[int, int, int] = WHITE, rectangle_drop: float = 0.4, rectangle_height: float = 0.5, ) -> displayio.Group: @@ -231,9 +228,7 @@ def _badge_background( color_palette = displayio.Palette(1) color_palette[0] = background_color - bg_sprite = displayio.TileGrid( - color_bitmap, pixel_shader=color_palette, x=0, y=0 - ) + bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) background_group.append(bg_sprite) rectangle = Rect( @@ -263,11 +258,10 @@ def image_background(self, image_name: Optional[str] = None) -> None: """ self._background_image_filename = image_name - # pylint: disable=too-many-arguments def badge_line( self, text: str = " ", - color: Tuple[int, int, int] = BLACK, + color: tuple[int, int, int] = BLACK, scale: int = 1, font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, left_justify: bool = False, @@ -359,9 +353,8 @@ def show_custom_badge(self) -> None: if not self._created_background: self._create_badge_background() - self.show(self._background_group) + self.root_group = self._background_group - # pylint: disable=too-many-arguments def _create_label_group( self, text: str, @@ -399,10 +392,7 @@ def _check_for_movement(self, movement_threshold: int = 10) -> bool: self._last_accelerometer = current_accelerometer return False acceleration_delta = sum( - [ - abs(self._last_accelerometer[n] - current_accelerometer[n]) - for n in range(3) - ] + abs(self._last_accelerometer[n] - current_accelerometer[n]) for n in range(3) ) self._last_accelerometer = current_accelerometer return acceleration_delta > movement_threshold @@ -449,13 +439,9 @@ def light(self) -> bool: return self._light_sensor.value @property - def acceleration(self) -> Tuple[int, int, int]: + def acceleration(self) -> tuple[int, int, int]: """Accelerometer data, +/- 2G sensitivity.""" - return ( - self._accelerometer.acceleration - if self._accelerometer is not None - else (0, 0, 0) - ) + return self._accelerometer.acceleration if self._accelerometer is not None else (0, 0, 0) @property def brightness(self) -> float: @@ -467,7 +453,6 @@ def brightness(self, value: float) -> None: self._display_brightness = value self.display.brightness = value - # pylint: disable=too-many-locals def show_business_card( self, *, @@ -553,24 +538,21 @@ def show_business_card( business_card_label_groups.append(email_two_group) business_card_splash = displayio.Group() - image_file = open(image_name, "rb") # pylint: disable=consider-using-with + image_file = open(image_name, "rb") on_disk_bitmap = displayio.OnDiskBitmap(image_file) - face_image = displayio.TileGrid( - on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader - ) + face_image = displayio.TileGrid(on_disk_bitmap, pixel_shader=on_disk_bitmap.pixel_shader) business_card_splash.append(face_image) for group in business_card_label_groups: business_card_splash.append(group) - self.show(business_card_splash) + self.root_group = business_card_splash - # pylint: disable=too-many-locals def show_badge( self, *, - background_color: Tuple[int, int, int] = RED, - foreground_color: Tuple[int, int, int] = WHITE, - background_text_color: Tuple[int, int, int] = WHITE, - foreground_text_color: Tuple[int, int, int] = BLACK, + background_color: tuple[int, int, int] = RED, + foreground_color: tuple[int, int, int] = WHITE, + background_text_color: tuple[int, int, int] = WHITE, + foreground_text_color: tuple[int, int, int] = BLACK, hello_font: Union[BuiltinFont, BDF, PCF] = terminalio.FONT, hello_scale: int = 1, hello_string: str = "HELLO", @@ -646,19 +628,25 @@ def show_badge( group.append(hello_group) group.append(my_name_is_group) group.append(name_group) - self.show(group) + self.root_group = group - def show(self, group) -> None: + @property + def root_group(self): + """The currently showing Group""" + return self.display.root_group + + @root_group.setter + def root_group(self, group): """Show the given group, refreshing the screen immediately""" self.activity() self.display.auto_refresh = False - self.display.show(group) + self.display.root_group = group self.display.refresh() self.display.auto_refresh = True def show_terminal(self) -> None: """Revert to terminalio screen.""" - self.show(None) + self.root_group = displayio.CIRCUITPYTHON_TERMINAL @staticmethod def bitmap_qr(matrix: adafruit_miniqr.QRBitMatrix) -> displayio.Bitmap: @@ -699,18 +687,14 @@ def show_qr_code(self, data: str = "https://circuitpython.org") -> None: self.display.width // qr_bitmap.width, self.display.height // qr_bitmap.height, ) - qr_position_x = int( - ((self.display.width / qr_code_scale) - qr_bitmap.width) / 2 - ) - qr_position_y = int( - ((self.display.height / qr_code_scale) - qr_bitmap.height) / 2 - ) + qr_position_x = int(((self.display.width / qr_code_scale) - qr_bitmap.width) / 2) + qr_position_y = int(((self.display.height / qr_code_scale) - qr_bitmap.height) / 2) qr_img = displayio.TileGrid( qr_bitmap, pixel_shader=palette, x=qr_position_x, y=qr_position_y ) qr_code = displayio.Group(scale=qr_code_scale) qr_code.append(qr_img) - self.show(qr_code) + self.root_group = qr_code @staticmethod def _sine_sample(length: int) -> Generator[int, None, None]: @@ -724,10 +708,7 @@ def _generate_sample(self, length: int = 100) -> None: if self._sample is not None: return self._sine_wave = array.array("H", PyBadgerBase._sine_sample(length)) - # pylint: disable=not-callable - self._sample = self._audio_out( - board.SPEAKER - ) # pylint: disable=not-callable + self._sample = self._audio_out(board.SPEAKER) self._sine_wave_sample = audiocore.RawSample(self._sine_wave) else: print("Required audio modules were missing") @@ -785,10 +766,8 @@ def play_file(self, file_name: str) -> None: # Play a specified file. self.stop_tone() self._enable_speaker(enable=True) - with self._audio_out(board.SPEAKER) as audio: # pylint: disable=not-callable - wavefile = audiocore.WaveFile( - open(file_name, "rb") # pylint: disable=consider-using-with - ) + with self._audio_out(board.SPEAKER) as audio: + wavefile = audiocore.WaveFile(open(file_name, "rb")) audio.play(wavefile) while audio.playing: pass diff --git a/adafruit_pybadger/pygamer.py b/adafruit_pybadger/pygamer.py index faf5ca0..c22d2c8 100644 --- a/adafruit_pybadger/pygamer.py +++ b/adafruit_pybadger/pygamer.py @@ -26,21 +26,23 @@ """ from collections import namedtuple -import board + +import adafruit_lis3dh import analogio -import digitalio import audioio -import neopixel +import board +import digitalio import keypad -import adafruit_lis3dh -from adafruit_pybadger.pybadger_base import PyBadgerBase, KeyStates +import neopixel + +from adafruit_pybadger.pybadger_base import KeyStates, PyBadgerBase try: - from typing import Type, Tuple + from typing import Tuple except ImportError: pass -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" Buttons = namedtuple("Buttons", "b a start select right down up left") @@ -59,9 +61,7 @@ def __init__(self) -> None: int1 = digitalio.DigitalInOut(board.ACCELEROMETER_INTERRUPT) try: - self._accelerometer = adafruit_lis3dh.LIS3DH_I2C( - i2c, address=0x19, int1=int1 - ) + self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, address=0x19, int1=int1) except ValueError: self._accelerometer = adafruit_lis3dh.LIS3DH_I2C(i2c, int1=int1) @@ -85,7 +85,7 @@ def __init__(self) -> None: self._light_sensor = analogio.AnalogIn(board.A7) @property - def button(self) -> Type[tuple]: + def button(self) -> Buttons: """The buttons on the board. Example use: @@ -106,9 +106,7 @@ def button(self) -> Type[tuple]: """ self._buttons.update() - button_values = tuple( - self._buttons.was_pressed(i) for i in range(self._keys.key_count) - ) + button_values = tuple(self._buttons.was_pressed(i) for i in range(self._keys.key_count)) x, y = self.joystick return Buttons( button_values[0], @@ -129,5 +127,5 @@ def joystick(self) -> Tuple[int, int]: return x, y -pygamer = PyGamer() # pylint: disable=invalid-name +pygamer = PyGamer() """Object that is automatically created on import.""" diff --git a/adafruit_pybadger/pyportal.py b/adafruit_pybadger/pyportal.py index 83e9604..38790a0 100644 --- a/adafruit_pybadger/pyportal.py +++ b/adafruit_pybadger/pyportal.py @@ -24,13 +24,15 @@ https://github.com/adafruit/circuitpython/releases """ -import board + import analogio import audioio +import board import neopixel + from adafruit_pybadger.pybadger_base import PyBadgerBase -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_PyBadger.git" @@ -62,5 +64,5 @@ def _unsupported(self): auto_dim_display = _unsupported -pyportal = PyPortal() # pylint: disable=invalid-name +pyportal = PyPortal() """Object that is automatically created on import.""" diff --git a/docs/api.rst b/docs/api.rst index a50522d..8db5080 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -4,6 +4,9 @@ .. If your library file(s) are nested in a directory (e.g. /adafruit_foo/foo.py) .. use this format as the module name: "adafruit_foo.foo" +API Reference +############# + .. automodule:: adafruit_pybadger.pybadger_base :members: diff --git a/docs/conf.py b/docs/conf.py index f541e09..2892cc5 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,8 @@ -# -*- coding: utf-8 -*- - # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries # # SPDX-License-Identifier: MIT +import datetime import os import sys @@ -17,6 +16,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", @@ -28,6 +28,7 @@ # autodoc module docs will fail to generate with a warning. autodoc_mock_imports = [ "audioio", + "bitmaptools", "displayio", "neopixel", "analogio", @@ -58,7 +59,12 @@ # General information about the project. project = "Adafruit PyBadger Library" -copyright = "2019 Kattni Rembor" +creation_year = "2019" +current_year = str(datetime.datetime.now().year) +year_duration = ( + current_year if current_year == creation_year else creation_year + " - " + current_year +) +copyright = year_duration + " Kattni Rembor" author = "Kattni Rembor" # The version info for the project you're documenting, acts as replacement for @@ -75,7 +81,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. @@ -107,19 +113,9 @@ # 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" # 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, diff --git a/docs/index.rst b/docs/index.rst index 5ce0d37..817fe4a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -31,7 +31,8 @@ Table of Contents .. toctree:: :caption: Other Links - Download + Download from GitHub + Download Library Bundle CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat diff --git a/docs/mocks/keypad.py b/docs/mocks/keypad.py index 5fcd12a..5226b76 100644 --- a/docs/mocks/keypad.py +++ b/docs/mocks/keypad.py @@ -26,7 +26,7 @@ def __init__( key_count, value_when_pressed, interval=0.020, - max_events=64 + max_events=64, ): self.key_count = 123 self.events = EventQueue() diff --git a/docs/requirements.txt b/docs/requirements.txt index 88e6733..979f568 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,4 +2,6 @@ # # SPDX-License-Identifier: Unlicense -sphinx>=4.0.0 +sphinx +sphinxcontrib-jquery +sphinx-rtd-theme diff --git a/examples/pybadger_button_debouncing.py b/examples/pybadger_button_debouncing.py index 9e13756..4617dee 100644 --- a/examples/pybadger_button_debouncing.py +++ b/examples/pybadger_button_debouncing.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT from adafruit_debouncer import Debouncer + from adafruit_pybadger import pybadger b_btn = Debouncer(lambda: pybadger.button.b == 0) diff --git a/examples/pybadger_clue_custom_badge.py b/examples/pybadger_clue_custom_badge.py index 280555e..db16e69 100644 --- a/examples/pybadger_clue_custom_badge.py +++ b/examples/pybadger_clue_custom_badge.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT """Custom badge example for Adafruit CLUE.""" + from adafruit_pybadger import pybadger pybadger.badge_background( @@ -11,16 +12,10 @@ rectangle_height=0.6, ) -pybadger.badge_line( - text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=2 -) -pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=3) -pybadger.badge_line( - text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2 -) -pybadger.badge_line( - text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=4 -) +pybadger.badge_line(text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=2) +pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=6) +pybadger.badge_line(text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2) +pybadger.badge_line(text="she/her", color=pybadger.BLINKA_PINK, scale=4, padding_above=7) pybadger.show_custom_badge() diff --git a/examples/pybadger_clue_custom_image_badge.py b/examples/pybadger_clue_custom_image_badge.py index c7bab34..777831d 100644 --- a/examples/pybadger_clue_custom_image_badge.py +++ b/examples/pybadger_clue_custom_image_badge.py @@ -2,15 +2,14 @@ # SPDX-License-Identifier: MIT """Custom image badge example for Adafruit CLUE.""" + from adafruit_pybadger import pybadger pybadger.image_background("Blinka_CLUE.bmp") pybadger.badge_line(text="@circuitpython", color=pybadger.SKY, scale=2, padding_above=2) pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=5, padding_above=3) -pybadger.badge_line( - text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2 -) +pybadger.badge_line(text="CircuitPythonista", color=pybadger.WHITE, scale=2, padding_above=2) pybadger.badge_line(text="she/her", color=pybadger.SKY, scale=4, padding_above=4) while True: diff --git a/examples/pybadger_custom_badge.py b/examples/pybadger_custom_badge.py index 070c191..1ccfed7 100644 --- a/examples/pybadger_custom_badge.py +++ b/examples/pybadger_custom_badge.py @@ -2,6 +2,7 @@ # SPDX-License-Identifier: MIT """Custom badge for PyBadge or PyGamer.""" + from adafruit_pybadger import pybadger pybadger.badge_background( @@ -11,16 +12,10 @@ rectangle_height=0.6, ) -pybadger.badge_line( - text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=1, padding_above=1 -) +pybadger.badge_line(text="@circuitpython", color=pybadger.BLINKA_PURPLE, scale=1, padding_above=1) pybadger.badge_line(text="Blinka", color=pybadger.WHITE, scale=3, padding_above=2) -pybadger.badge_line( - text="CircuitPythonista", color=pybadger.WHITE, scale=1, padding_above=1 -) -pybadger.badge_line( - text="she/her", color=pybadger.BLINKA_PINK, scale=2, padding_above=2 -) +pybadger.badge_line(text="CircuitPythonista", color=pybadger.WHITE, scale=1, padding_above=1) +pybadger.badge_line(text="she/her", color=pybadger.BLINKA_PINK, scale=2, padding_above=2) while True: pybadger.show_custom_badge() diff --git a/examples/pybadger_magtag_simpletest.py b/examples/pybadger_magtag_simpletest.py index 504c7c7..a92db0f 100644 --- a/examples/pybadger_magtag_simpletest.py +++ b/examples/pybadger_magtag_simpletest.py @@ -2,10 +2,13 @@ # SPDX-License-Identifier: MIT """Simpletest example using the Mag Tag. - Use the A, B, and C buttons to change between examples.""" +Use the A, B, and C buttons to change between examples.""" + import time + import board import digitalio + from adafruit_pybadger import pybadger @@ -44,9 +47,7 @@ def try_refresh(): SHOWING = "badge" -pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 -) +pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) try_refresh() @@ -55,7 +56,6 @@ def try_refresh(): pybadger.pixels.fill(0x000022) while True: - cur_a = btn_a.value cur_b = btn_b.value cur_c = btn_c.value diff --git a/examples/pybadger_pewpewm4_simpletest.py b/examples/pybadger_pewpewm4_simpletest.py index 1094d42..0c71069 100644 --- a/examples/pybadger_pewpewm4_simpletest.py +++ b/examples/pybadger_pewpewm4_simpletest.py @@ -2,12 +2,11 @@ # SPDX-License-Identifier: MIT """Simpletest example using the Pew Pew M4. - Use the O, X, and Z buttons to change between examples.""" +Use the O, X, and Z buttons to change between examples.""" + from adafruit_pybadger import pybadger -pybadger.show_badge( - name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4 -) +pybadger.show_badge(name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4) while True: if pybadger.button.o: @@ -23,6 +22,4 @@ elif pybadger.button.x: pybadger.show_qr_code(data="https://circuitpython.org") elif pybadger.button.z: - pybadger.show_badge( - name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4 - ) + pybadger.show_badge(name_string="Blinka", hello_scale=3, my_name_is_scale=3, name_scale=4) diff --git a/examples/pybadger_pygamer_asyncio.py b/examples/pybadger_pygamer_asyncio.py index 3433207..c3ac367 100644 --- a/examples/pybadger_pygamer_asyncio.py +++ b/examples/pybadger_pygamer_asyncio.py @@ -1,11 +1,12 @@ # SPDX-FileCopyrightText: 2022 Jeff Epler for Adafruit Industries # SPDX-License-Identifier: MIT -# pylint: disable=consider-using-with import asyncio -from displayio import TileGrid, OnDiskBitmap, Group + +from displayio import Group, OnDiskBitmap, TileGrid from rainbowio import colorwheel + from adafruit_pybadger import pybadger # If you choose to enter a pronoun it's shown on the "business card" page @@ -26,17 +27,14 @@ rectangle_height=0.55, ) -pybadger.badge_line( - text="HELLO I'M", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=1 -) +pybadger.badge_line(text="HELLO I'M", color=pybadger.BLINKA_PURPLE, scale=2, padding_above=1) pybadger.badge_line(text=custom_line1, color=pybadger.WHITE, scale=6, padding_above=1) -pybadger.badge_line( - text=custom_line2, color=pybadger.BLINKA_PURPLE, scale=2, padding_above=0.25 -) +pybadger.badge_line(text=custom_line2, color=pybadger.BLINKA_PURPLE, scale=2, padding_above=0.25) # Start with the custom badge page pybadger.show_custom_badge() + # This task responds to buttons and changes the visible page async def ui_task(): while True: @@ -49,7 +47,7 @@ async def ui_task(): email_string_two=pronoun, ) elif pybadger.button.b: - pybadger.show(qr_gp) + pybadger.root_group = qr_gp elif pybadger.button.start: pybadger.show_custom_badge() elif pybadger.button.select: diff --git a/examples/pybadger_pyportal_touchscreen.py b/examples/pybadger_pyportal_touchscreen.py index 10ce9c4..7633b26 100644 --- a/examples/pybadger_pyportal_touchscreen.py +++ b/examples/pybadger_pyportal_touchscreen.py @@ -2,11 +2,11 @@ # SPDX-License-Identifier: MIT """Simpletest example using Adafruit PyPortal. Uses the touchscreen to advance between examples.""" -import board + import adafruit_touchscreen -from adafruit_pybadger import pybadger +import board -# pylint: disable=invalid-name +from adafruit_pybadger import pybadger # These pins are used as both analog and digital! XL, XR and YU must be analog # and digital capable. YD just need to be digital @@ -19,9 +19,7 @@ size=(320, 240), ) -pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 -) +pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) cur_example = 0 prev_touch = None @@ -45,6 +43,4 @@ elif cur_example == 1: pybadger.show_qr_code(data="https://circuitpython.org") elif cur_example == 2: - pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 - ) + pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) diff --git a/examples/pybadger_simpletest.py b/examples/pybadger_simpletest.py index a720208..dd3657b 100644 --- a/examples/pybadger_simpletest.py +++ b/examples/pybadger_simpletest.py @@ -3,9 +3,7 @@ from adafruit_pybadger import pybadger -pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 -) +pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) while True: pybadger.auto_dim_display( @@ -22,6 +20,4 @@ elif pybadger.button.b: pybadger.show_qr_code(data="https://circuitpython.org") elif pybadger.button.start: - pybadger.show_badge( - name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3 - ) + pybadger.show_badge(name_string="Blinka", hello_scale=2, my_name_is_scale=2, name_scale=3) 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 new file mode 100644 index 0000000..8d4a8b1 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,46 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-pybadger" +description = "Badge-focused CircuitPython helper library for PyBadge, PyBadge LC, PyGamer and CLUE" +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_PyBadger"} +keywords = [ + "adafruit", + "pybadge", + "pygamer", + "clue", + "display", + "hardware", + "micropythoncircuitpython", +] +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_pybadger"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 6e1974a..92bd3f5 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,13 +1,13 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense Adafruit-Blinka adafruit-circuitpython-bitmap-font -adafruit-circuitpython-display-shapes -adafruit-circuitpython-display-text -adafruit-circuitpython-gizmo -adafruit-circuitpython-lis3dh adafruit-circuitpython-lsm6ds +adafruit-circuitpython-display-text adafruit-circuitpython-miniqr adafruit-circuitpython-neopixel +adafruit-circuitpython-gizmo +adafruit-circuitpython-lis3dh +adafruit-circuitpython-display-shapes diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..b485fab --- /dev/null +++ b/ruff.toml @@ -0,0 +1,108 @@ +# SPDX-FileCopyrightText: 2024 Tim Cocks for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +target-version = "py38" +line-length = 100 + +[lint] +preview = true +select = ["I", "PL", "UP"] + +extend-select = [ + "D419", # empty-docstring + "E501", # line-too-long + "W291", # trailing-whitespace + "PLC0414", # useless-import-alias + "PLC2401", # non-ascii-name + "PLC2801", # unnecessary-dunder-call + "PLC3002", # unnecessary-direct-lambda-call + "E999", # syntax-error + "PLE0101", # return-in-init + "F706", # return-outside-function + "F704", # yield-outside-function + "PLE0116", # continue-in-finally + "PLE0117", # nonlocal-without-binding + "PLE0241", # duplicate-bases + "PLE0302", # unexpected-special-method-signature + "PLE0604", # invalid-all-object + "PLE0605", # invalid-all-format + "PLE0643", # potential-index-error + "PLE0704", # misplaced-bare-raise + "PLE1141", # dict-iter-missing-items + "PLE1142", # await-outside-async + "PLE1205", # logging-too-many-args + "PLE1206", # logging-too-few-args + "PLE1307", # bad-string-format-type + "PLE1310", # bad-str-strip-call + "PLE1507", # invalid-envvar-value + "PLE2502", # bidirectional-unicode + "PLE2510", # invalid-character-backspace + "PLE2512", # invalid-character-sub + "PLE2513", # invalid-character-esc + "PLE2514", # invalid-character-nul + "PLE2515", # invalid-character-zero-width-space + "PLR0124", # comparison-with-itself + "PLR0202", # no-classmethod-decorator + "PLR0203", # no-staticmethod-decorator + "UP004", # useless-object-inheritance + "PLR0206", # property-with-parameters + "PLR0904", # too-many-public-methods + "PLR0911", # too-many-return-statements + "PLR0912", # too-many-branches + "PLR0913", # too-many-arguments + "PLR0914", # too-many-locals + "PLR0915", # too-many-statements + "PLR0916", # too-many-boolean-expressions + "PLR1702", # too-many-nested-blocks + "PLR1704", # redefined-argument-from-local + "PLR1711", # useless-return + "C416", # unnecessary-comprehension + "PLR1733", # unnecessary-dict-index-lookup + "PLR1736", # unnecessary-list-index-lookup + + # ruff reports this rule is unstable + #"PLR6301", # no-self-use + + "PLW0108", # unnecessary-lambda + "PLW0120", # useless-else-on-loop + "PLW0127", # self-assigning-variable + "PLW0129", # assert-on-string-literal + "B033", # duplicate-value + "PLW0131", # named-expr-without-context + "PLW0245", # super-without-brackets + "PLW0406", # import-self + "PLW0602", # global-variable-not-assigned + "PLW0603", # global-statement + "PLW0604", # global-at-module-level + + # fails on the try: import typing used by libraries + #"F401", # unused-import + + "F841", # unused-variable + "E722", # bare-except + "PLW0711", # binary-op-exception + "PLW1501", # bad-open-mode + "PLW1508", # invalid-envvar-default + "PLW1509", # subprocess-popen-preexec-fn + "PLW2101", # useless-with-lock + "PLW3301", # nested-min-max +] + +ignore = [ + "PLR2004", # magic-value-comparison + "UP030", # format literals + "PLW1514", # unspecified-encoding + "PLR0913", # too-many-arguments + "PLR0915", # too-many-statements + "PLR0917", # too-many-positional-arguments + "PLR0904", # too-many-public-methods + "PLR0912", # too-many-branches + "PLR0916", # too-many-boolean-expressions + "PLR6301", # could-be-static no-self-use + "PLC0415", # import outside toplevel + "UP007", # x | y type annotation +] + +[format] +line-ending = "lf" diff --git a/setup.py.disabled b/setup.py.disabled deleted file mode 100644 index 79220aa..0000000 --- a/setup.py.disabled +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: MIT -""" -This library is not deployed to PyPI. It is either a board-specific helper library, or -does not make sense for use on or is incompatible with single board computers and Linux. -"""