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/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 ca35544..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.7 - uses: actions/setup-python@v1 - with: - python-version: 3.7 - - 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 6d0015a..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.6 - uses: actions/setup-python@v1 - with: - python-version: 3.6 - - 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@v1 - 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 ced7313..db3d538 100644 --- a/.gitignore +++ b/.gitignore @@ -1,9 +1,48 @@ -# SPDX-FileCopyrightText: 2021 ladyada 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 + +# 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 -bundles +.venv + +# MacOS-specific files +*.DS_Store + +# IDE-specific files +.idea +.vscode +*~ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 1b9fadc..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: 20.8b1 + - 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 - 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 new file mode 100644 index 0000000..255dafd --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,22 @@ +# 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 + +sphinx: + configuration: docs/conf.py + +build: + os: ubuntu-lts-latest + tools: + python: "3" + +python: + install: + - requirements: docs/requirements.txt + - requirements: requirements.txt diff --git a/.readthedocs.yml b/.readthedocs.yml deleted file mode 100644 index 49dcab3..0000000 --- a/.readthedocs.yml +++ /dev/null @@ -1,7 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries -# -# SPDX-License-Identifier: Unlicense - -python: - version: 3 -requirements_file: docs/requirements.txt diff --git a/README.rst b/README.rst index 82f1151..2d178b8 100644 --- a/README.rst +++ b/README.rst @@ -2,10 +2,10 @@ Introduction ============ .. image:: https://readthedocs.org/projects/adafruit-circuitpython-bluefruitconnect/badge/?version=latest - :target: https://circuitpython.readthedocs.io/projects/bluefruitconnect/en/latest/ + :target: https://docs.circuitpython.org/projects/bluefruitconnect/en/latest/ :alt: Documentation Status -.. image:: https://img.shields.io/discord/327254708534116352.svg +.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg :target: https://adafru.it/discord :alt: Discord @@ -13,6 +13,10 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect/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 + This module helps you to communicate with the Adafruit Bluefruit Connect app or use its protocols. Dependencies @@ -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-bluefruitconnect Usage Example @@ -74,7 +78,9 @@ Below is a simple standalone 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 `_. + +For information on building library documentation, please check out `this guide `_. Contributing ============ @@ -82,8 +88,3 @@ 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 `_. diff --git a/adafruit_bluefruit_connect/__init__.py b/adafruit_bluefruit_connect/__init__.py index 26e614c..c5eba7d 100644 --- a/adafruit_bluefruit_connect/__init__.py +++ b/adafruit_bluefruit_connect/__init__.py @@ -17,5 +17,5 @@ # imports -__version__ = "0.0.0-auto.0" +__version__ = "0.0.0+auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect.git" diff --git a/adafruit_bluefruit_connect/_xyz_packet.py b/adafruit_bluefruit_connect/_xyz_packet.py index 37cfa58..5b3267b 100644 --- a/adafruit_bluefruit_connect/_xyz_packet.py +++ b/adafruit_bluefruit_connect/_xyz_packet.py @@ -12,6 +12,8 @@ """ +from __future__ import annotations + import struct from .packet import Packet @@ -20,20 +22,20 @@ class _XYZPacket(Packet): """A packet of x, y, z float values. Used for several different Bluefruit controller packets.""" - _FMT_PARSE = " None: # Construct an _XYZPacket subclass object # from the given x, y, and z float values, and type character. self._x = x self._y = y self._z = z - def to_bytes(self): + def to_bytes(self) -> bytes: """Return the bytes needed to send this packet.""" partial_packet = struct.pack( self._FMT_CONSTRUCT, self._TYPE_HEADER, self._x, self._y, self._z @@ -41,16 +43,16 @@ def to_bytes(self): return self.add_checksum(partial_packet) @property - def x(self): + def x(self) -> float: """The x value.""" return self._x @property - def y(self): + def y(self) -> float: """The y value.""" return self._y @property - def z(self): + def z(self) -> float: """The z value.""" return self._z diff --git a/adafruit_bluefruit_connect/accelerometer_packet.py b/adafruit_bluefruit_connect/accelerometer_packet.py index fc64554..a8ef855 100644 --- a/adafruit_bluefruit_connect/accelerometer_packet.py +++ b/adafruit_bluefruit_connect/accelerometer_packet.py @@ -12,6 +12,8 @@ """ +from __future__ import annotations + from ._xyz_packet import _XYZPacket @@ -19,7 +21,7 @@ class AccelerometerPacket(_XYZPacket): """A packet of x, y, z float values from an accelerometer.""" # Everything else is handled by _XYZPacket. - _TYPE_HEADER = b"!A" + _TYPE_HEADER: bytes = b"!A" # Register this class with the superclass. This allows the user to import only what is needed. diff --git a/adafruit_bluefruit_connect/button_packet.py b/adafruit_bluefruit_connect/button_packet.py index 36542a0..168cbba 100644 --- a/adafruit_bluefruit_connect/button_packet.py +++ b/adafruit_bluefruit_connect/button_packet.py @@ -13,39 +13,45 @@ """ +from __future__ import annotations + import struct from .packet import Packet +try: + from typing import Optional # adjust these as needed +except ImportError: + pass + class ButtonPacket(Packet): """A packet containing a button name and its state.""" - BUTTON_1 = "1" + BUTTON_1: str = "1" """Code for Button 1 on the Bluefruit LE Connect app Control Pad screen.""" - BUTTON_2 = "2" + BUTTON_2: str = "2" """Button 2.""" - BUTTON_3 = "3" + BUTTON_3: str = "3" """Button 3.""" - BUTTON_4 = "4" + BUTTON_4: str = "4" """Button 4.""" - # pylint: disable= invalid-name - UP = "5" + UP: str = "5" """Up Button.""" - DOWN = "6" + DOWN: str = "6" """Down Button.""" - LEFT = "7" + LEFT: str = "7" """Left Button.""" - RIGHT = "8" + RIGHT: str = "8" """Right Button.""" - _FMT_PARSE = " None: """Construct a ButtonPacket from a button name and the button's state. :param str button: a single character denoting the button @@ -59,11 +65,11 @@ def __init__(self, button, pressed): except Exception as err: raise ValueError("Button must be a single char.") from err - self._button = button - self._pressed = pressed + self._button: str = button + self._pressed: bool = pressed @classmethod - def parse_private(cls, packet): + def parse_private(cls, packet: bytes) -> Optional[Packet]: """Construct a ButtonPacket from an incoming packet. Do not call this directly; call Packet.from_bytes() instead. pylint makes it difficult to call this method _parse(), hence the name. @@ -73,9 +79,9 @@ def parse_private(cls, packet): raise ValueError("Bad button press/release value") return cls(chr(button[0]), pressed == b"1") - def to_bytes(self): + def to_bytes(self) -> bytes: """Return the bytes needed to send this packet.""" - partial_packet = struct.pack( + partial_packet: bytes = struct.pack( self._FMT_CONSTRUCT, self._TYPE_HEADER, bytes(self._button, "utf-8"), @@ -84,13 +90,13 @@ def to_bytes(self): return self.add_checksum(partial_packet) @property - def button(self): + def button(self) -> str: """A single character string (not bytes) specifying the button that the user pressed or released.""" return self._button @property - def pressed(self): + def pressed(self) -> bool: """``True`` if button is pressed, or ``False`` if it is released.""" return self._pressed diff --git a/adafruit_bluefruit_connect/color_packet.py b/adafruit_bluefruit_connect/color_packet.py index 9056d84..0c1f153 100644 --- a/adafruit_bluefruit_connect/color_packet.py +++ b/adafruit_bluefruit_connect/color_packet.py @@ -12,21 +12,28 @@ """ +from __future__ import annotations + import struct from .packet import Packet +try: + from typing import Optional, Tuple # adjust these as needed +except ImportError: + pass + class ColorPacket(Packet): """A packet containing an RGB color value.""" - _FMT_PARSE = " None: """Construct a ColorPacket from a 3-element :class:`tuple` of RGB values, or from an int color value 0xRRGGBB. @@ -34,29 +41,27 @@ def __init__(self, color): or an int color value ``0xRRGGBB`` """ if isinstance(color, int): - self._color = tuple(color.to_bytes("BBB", "big")) + self._color: Tuple = tuple(color.to_bytes(3, "big")) elif len(color) == 3 and all(0 <= c <= 255 for c in color): self._color = color else: raise ValueError("Color must be an integer 0xRRGGBB or a tuple(r,g,b)") @classmethod - def parse_private(cls, packet): + def parse_private(cls, packet: bytes) -> Optional[Packet]: """Construct a ColorPacket from an incoming packet. Do not call this directly; call Packet.from_bytes() instead. pylint makes it difficult to call this method _parse(), hence the name. """ return cls(struct.unpack(cls._FMT_PARSE, packet)) - def to_bytes(self): + def to_bytes(self) -> bytes: """Return the bytes needed to send this packet.""" - partial_packet = struct.pack( - self._FMT_CONSTRUCT, self._TYPE_HEADER, *self._color - ) + partial_packet = struct.pack(self._FMT_CONSTRUCT, self._TYPE_HEADER, *self._color) return self.add_checksum(partial_packet) @property - def color(self): + def color(self) -> tuple: """A :class:`tuple` ``(red, green blue)`` representing the color the user chose in the BlueFruit Connect app.""" return self._color diff --git a/adafruit_bluefruit_connect/gyro_packet.py b/adafruit_bluefruit_connect/gyro_packet.py index 7362119..0f17fa3 100644 --- a/adafruit_bluefruit_connect/gyro_packet.py +++ b/adafruit_bluefruit_connect/gyro_packet.py @@ -12,6 +12,8 @@ """ +from __future__ import annotations + from ._xyz_packet import _XYZPacket @@ -19,7 +21,7 @@ class GyroPacket(_XYZPacket): """A packet of x, y, z float values from a gyroscope.""" # Everything else is handled by _XYZPacket. - _TYPE_HEADER = b"!G" + _TYPE_HEADER: bytes = b"!G" # Register this class with the superclass. This allows the user to import only what is needed. diff --git a/adafruit_bluefruit_connect/location_packet.py b/adafruit_bluefruit_connect/location_packet.py index c7bae5d..e27dbc6 100644 --- a/adafruit_bluefruit_connect/location_packet.py +++ b/adafruit_bluefruit_connect/location_packet.py @@ -12,6 +12,8 @@ """ +from __future__ import annotations + import struct from .packet import Packet @@ -20,19 +22,19 @@ class LocationPacket(Packet): """A packet of latitude, longitude, and altitude values.""" - _FMT_PARSE = " None: """Construct a LocationPacket from the given values.""" self._latitude = latitude self._longitude = longitude self._altitude = altitude - def to_bytes(self): + def to_bytes(self) -> bytes: """Return the bytes needed to send this packet.""" partial_packet = struct.pack( self._FMT_CONSTRUCT, @@ -44,17 +46,17 @@ def to_bytes(self): return self.add_checksum(partial_packet) @property - def latitude(self): + def latitude(self) -> float: """The latitude value.""" return self._latitude @property - def longitude(self): + def longitude(self) -> float: """The longitude value.""" return self._longitude @property - def altitude(self): + def altitude(self) -> float: """The altitude value.""" return self._altitude diff --git a/adafruit_bluefruit_connect/magnetometer_packet.py b/adafruit_bluefruit_connect/magnetometer_packet.py index ef4cff3..5dbaa31 100644 --- a/adafruit_bluefruit_connect/magnetometer_packet.py +++ b/adafruit_bluefruit_connect/magnetometer_packet.py @@ -12,6 +12,8 @@ """ +from __future__ import annotations + from ._xyz_packet import _XYZPacket @@ -19,7 +21,7 @@ class MagnetometerPacket(_XYZPacket): """A packet of x, y, z float values from a magnetometer.""" # Everything else is handled by _XYZPacket. - _TYPE_HEADER = b"!M" + _TYPE_HEADER: bytes = b"!M" # Register this class with the superclass. This allows the user to import only what is needed. diff --git a/adafruit_bluefruit_connect/packet.py b/adafruit_bluefruit_connect/packet.py index 5e8ead7..d099ad2 100644 --- a/adafruit_bluefruit_connect/packet.py +++ b/adafruit_bluefruit_connect/packet.py @@ -12,8 +12,16 @@ """ +from __future__ import annotations + import struct +try: + from io import RawIOBase + from typing import Any, Optional # adjust these as needed +except ImportError: + pass + class Packet: """ @@ -31,18 +39,18 @@ class Packet: # All concrete subclasses should define these class attributes. They're listed here # as a reminder and to make pylint happy. # _FMT_PARSE is the whole packet. - _FMT_PARSE = None + _FMT_PARSE: str # In each class, set PACKET_LENGTH = struct.calcsize(_FMT_PARSE). - PACKET_LENGTH = None + PACKET_LENGTH: int # _FMT_CONSTRUCT does not include the trailing byte, which is the checksum. - _FMT_CONSTRUCT = None + _FMT_CONSTRUCT: Optional[str] = None # The first byte of the prefix is always b'!'. The second byte is the type code. - _TYPE_HEADER = None + _TYPE_HEADER: Optional[bytes] = None - _type_to_class = {} + _type_to_class: dict = {} @classmethod - def register_packet_type(cls): + def register_packet_type(cls: Any) -> None: """Register a new packet type, using this class and its ``cls._TYPE_HEADER``. The ``from_bytes()`` and ``from_stream()`` methods will then be able to recognize this type of packet. @@ -51,7 +59,7 @@ def register_packet_type(cls): Packet._type_to_class[cls._TYPE_HEADER] = cls @classmethod - def from_bytes(cls, packet): + def from_bytes(cls, packet: bytes) -> Packet: """Create an appropriate object of the correct class for the given packet bytes. Validate packet type, length, and checksum. """ @@ -59,12 +67,12 @@ def from_bytes(cls, packet): raise ValueError("Packet too short") packet_class = cls._type_to_class.get(packet[0:2], None) if not packet_class: - raise ValueError("Unregistered packet type {}".format(packet[0:2])) + raise ValueError(f"Unregistered packet type {packet[0:2]}") # In case this was called from a subclass, make sure the parsed # type matches up with the current class. if not issubclass(packet_class, cls): - raise ValueError("Packet type is not a {}".format(cls.__name__)) + raise ValueError(f"Packet type is not a {cls.__name__}") if len(packet) != packet_class.PACKET_LENGTH: raise ValueError("Wrong length packet") @@ -76,12 +84,15 @@ def from_bytes(cls, packet): return packet_class.parse_private(packet) @classmethod - def from_stream(cls, stream): + def from_stream(cls, stream: RawIOBase) -> Optional[Packet]: """Read the next packet from the incoming stream. Wait as long as the timeout set on stream, using its own preset timeout. Return None if there was no input, otherwise return an instance of one of the packet classes registered with ``Packet``. - Raise an Error if the packet was not recognized or was malformed + Raise an Error if the packet was not recognized or was malformed. + + If a packet of type "RT" (like ``RawTextPacket``) is registered, it will be + used to return the raw data line when no packet type was recognized. :param stream stream: an input stream that provides standard stream read operations, such as ``ble.UARTServer`` or ``busio.UART``. @@ -94,6 +105,7 @@ def from_stream(cls, stream): if not start: # Timeout: nothing read. return None + if start == b"!": # Found start of packet. packet_type = stream.read(1) @@ -101,17 +113,28 @@ def from_stream(cls, stream): # Timeout: nothing more read. return None break - # Didn't find a packet start. Loop and try again. + + # Didn't find a packet start. + raw_text_packet_cls = cls._type_to_class.get(b"RT", None) + # Is RawTextPacket registered? + # If so, read an entire line and pass that to RawTextPacket. + if raw_text_packet_cls: + packet = bytes(start + stream.readline()) + return raw_text_packet_cls(packet) + + # else loop and try again. header = bytes(start + packet_type) packet_class = cls._type_to_class.get(header, None) if not packet_class: - raise ValueError("Unregistered packet type {}".format(header)) - packet = header + stream.read(packet_class.PACKET_LENGTH - 2) + raise ValueError(f"Unregistered packet type {header}") + rest = stream.read(packet_class.PACKET_LENGTH - 2) + assert rest is not None + packet = header + rest return cls.from_bytes(packet) @classmethod - def parse_private(cls, packet): + def parse_private(cls, packet: bytes) -> Optional[Packet]: """Default implementation for subclasses. Assumes arguments to ``__init__()`` are exactly the values parsed using ``cls._FMT_PARSE``. Subclasses may need to reimplement if that assumption @@ -123,11 +146,11 @@ def parse_private(cls, packet): return cls(*struct.unpack(cls._FMT_PARSE, packet)) @staticmethod - def checksum(partial_packet): + def checksum(partial_packet: bytes) -> int: """Compute checksum for bytes, not including the checksum byte itself.""" return ~sum(partial_packet) & 0xFF - def add_checksum(self, partial_packet): + def add_checksum(self, partial_packet: bytes) -> bytes: """Compute the checksum of partial_packet and return a new bytes with the checksum appended. """ diff --git a/adafruit_bluefruit_connect/quaternion_packet.py b/adafruit_bluefruit_connect/quaternion_packet.py index 359b1bf..f1b912e 100644 --- a/adafruit_bluefruit_connect/quaternion_packet.py +++ b/adafruit_bluefruit_connect/quaternion_packet.py @@ -12,6 +12,8 @@ """ +from __future__ import annotations + import struct from ._xyz_packet import _XYZPacket @@ -23,26 +25,26 @@ class QuaternionPacket(_XYZPacket): # Use _XYZPacket to handle x, y, z, and add w. - _FMT_PARSE = " None: """Construct a QuaternionPacket from the given x, y, z, and w float values.""" super().__init__(x, y, z) self._w = w - def to_bytes(self): + def to_bytes(self) -> bytes: """Return the bytes needed to send this packet.""" partial_packet = struct.pack( self._FMT_CONSTRUCT, self._TYPE_HEADER, self._x, self._y, self._z, self._w ) - return partial_packet + self.checksum(partial_packet) + return partial_packet + bytes((self.checksum(partial_packet),)) @property - def w(self): + def w(self) -> float: """The w value.""" return self._w diff --git a/adafruit_bluefruit_connect/raw_text_packet.py b/adafruit_bluefruit_connect/raw_text_packet.py new file mode 100644 index 0000000..0c82b16 --- /dev/null +++ b/adafruit_bluefruit_connect/raw_text_packet.py @@ -0,0 +1,49 @@ +# SPDX-FileCopyrightText: 2021 Tony Hansen +# +# SPDX-License-Identifier: MIT + +""" +`adafruit_bluefruit_connect.raw_text_packet` +==================================================== + +Bluefruit Connect App raw text data packet. + +Note that the raw text data packet is different from those used by the +Controller module (e.g. Accelerometer, Control Pad, and Color Picker). +Those use the bytes "!x" (where x is specific to the type of packet), +followed by data specific to the packet, followed by a checksum. +The UART text sender instead sends the bytes followed by a newline. +There is no length indicator, no checksum, etc. Of course, that also +precludes the use of an "!" at the beginning of the string. + +Consequently, this packet type is MUCH simpler than the other packet types. + +* Author(s): Tony Hansen + +""" + +from __future__ import annotations + +from .packet import Packet + + +class RawTextPacket(Packet): + """A packet containing a text string.""" + + _TYPE_HEADER: bytes = b"RT" + + def __init__(self, text: str) -> None: + """Construct a RawTextPacket from a binary string.""" + if isinstance(text, bytes): + self._text: str = text.strip() + else: + raise ValueError("Text must be a bytes string") + + @property + def text(self) -> str: + """Return the text associated with the object.""" + return self._text + + +# Register this class with the superclass. This allows the user to import only what is needed. +RawTextPacket.register_packet_type() diff --git a/docs/api.rst b/docs/api.rst index c32ec68..51d1c3a 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_bluefruit_connect :members: @@ -30,3 +33,6 @@ .. automodule:: adafruit_bluefruit_connect.quaternion_packet :members: + +.. automodule:: adafruit_bluefruit_connect.raw_text_packet + :members: diff --git a/docs/conf.py b/docs/conf.py index 0e1d533..a9c3bd5 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 @@ -16,6 +15,7 @@ # ones. extensions = [ "sphinx.ext.autodoc", + "sphinxcontrib.jquery", "sphinx.ext.intersphinx", "sphinx.ext.napoleon", "sphinx.ext.todo", @@ -29,8 +29,8 @@ intersphinx_mapping = { - "python": ("https://docs.python.org/3.4", None), - "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), + "python": ("https://docs.python.org/3", None), + "CircuitPython": ("https://docs.circuitpython.org/en/latest/", None), } autoclass_content = "both" @@ -45,7 +45,12 @@ # General information about the project. project = "Adafruit Bluefruit Connect Library" -copyright = "2019 Dan Halbert" +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 + " Dan Halbert" author = "Dan Halbert" # The version info for the project you're documenting, acts as replacement for @@ -62,7 +67,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. @@ -94,19 +99,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/examples.rst b/docs/examples.rst index a672dc8..17844cd 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -24,3 +24,10 @@ This example demonstrates receiving text from the UART interface. .. literalinclude:: ../examples/bluefruitconnect_uart.py :caption: examples/bluefruitconnect_uart.py :linenos: + +This example demonstrates receiving both a color (as in simpletest above) +and raw text (using RawTextPacket). + +.. literalinclude:: ../examples/bluefruitconnect_simpletest2.py + :caption: examples/bluefruitconnect_simpletest2.py + :linenos: diff --git a/docs/index.rst b/docs/index.rst index 442e206..85880ff 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,8 +29,9 @@ Table of Contents .. toctree:: :caption: Other Links - Download - CircuitPython Reference Documentation + Download from GitHub + Download Library Bundle + CircuitPython Reference Documentation CircuitPython Support Forum Discord Chat Adafruit Learning System 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/bluefruitconnect_controlpad.py b/examples/bluefruitconnect_controlpad.py index e59f6e4..fe5457f 100644 --- a/examples/bluefruitconnect_controlpad.py +++ b/examples/bluefruitconnect_controlpad.py @@ -8,10 +8,10 @@ from adafruit_ble import BLERadio from adafruit_ble.advertising.standard import ProvideServicesAdvertisement from adafruit_ble.services.nordic import UARTService -from adafruit_bluefruit_connect.packet import Packet # Only the packet classes that are imported will be known to Packet. from adafruit_bluefruit_connect.button_packet import ButtonPacket +from adafruit_bluefruit_connect.packet import Packet ble = BLERadio() uart_server = UARTService() @@ -30,7 +30,6 @@ # Loop and read packets while ble.connected: - # Keeping trying until a good packet is received try: packet = Packet.from_stream(uart_server) diff --git a/examples/bluefruitconnect_sensors.py b/examples/bluefruitconnect_sensors.py index 30175c2..218bf60 100644 --- a/examples/bluefruitconnect_sensors.py +++ b/examples/bluefruitconnect_sensors.py @@ -8,13 +8,13 @@ from adafruit_ble import BLERadio from adafruit_ble.advertising.standard import ProvideServicesAdvertisement from adafruit_ble.services.nordic import UARTService -from adafruit_bluefruit_connect.packet import Packet # Only the packet classes that are imported will be known to Packet. from adafruit_bluefruit_connect.accelerometer_packet import AccelerometerPacket from adafruit_bluefruit_connect.gyro_packet import GyroPacket from adafruit_bluefruit_connect.location_packet import LocationPacket from adafruit_bluefruit_connect.magnetometer_packet import MagnetometerPacket +from adafruit_bluefruit_connect.packet import Packet from adafruit_bluefruit_connect.quaternion_packet import QuaternionPacket ble = BLERadio() @@ -34,7 +34,6 @@ # Loop and read packets while ble.connected: - # Keeping trying until a good packet is received try: packet = Packet.from_stream(uart_server) diff --git a/examples/bluefruitconnect_simpletest.py b/examples/bluefruitconnect_simpletest.py index f0deca1..3f71e92 100644 --- a/examples/bluefruitconnect_simpletest.py +++ b/examples/bluefruitconnect_simpletest.py @@ -8,10 +8,10 @@ from adafruit_ble import BLERadio from adafruit_ble.advertising.standard import ProvideServicesAdvertisement from adafruit_ble.services.nordic import UARTService -from adafruit_bluefruit_connect.packet import Packet # Only the packet classes that are imported will be known to Packet. from adafruit_bluefruit_connect.color_packet import ColorPacket +from adafruit_bluefruit_connect.packet import Packet ble = BLERadio() uart_server = UARTService() diff --git a/examples/bluefruitconnect_simpletest2.py b/examples/bluefruitconnect_simpletest2.py new file mode 100644 index 0000000..596e23c --- /dev/null +++ b/examples/bluefruitconnect_simpletest2.py @@ -0,0 +1,35 @@ +# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-License-Identifier: MIT + +# Print out the color data from ColorPackets and text data from RawTextPackets. +# To use, start this program, and start the Adafruit Bluefruit LE Connect app. +# Connect, and then select colors on the Controller->Color Picker screen. +# Select text by entering the UART screen and sending a string. +# (Do NOT use a "!" at the start of your string.) + +from adafruit_ble import BLERadio +from adafruit_ble.advertising.standard import ProvideServicesAdvertisement +from adafruit_ble.services.nordic import UARTService + +# Only the packet classes that are imported will be known to Packet. +from adafruit_bluefruit_connect.color_packet import ColorPacket +from adafruit_bluefruit_connect.packet import Packet +from adafruit_bluefruit_connect.raw_text_packet import RawTextPacket + +ble = BLERadio() +uart_server = UARTService() +advertisement = ProvideServicesAdvertisement(uart_server) + +while True: + # Advertise when not connected. + ble.start_advertising(advertisement) + while not ble.connected: + pass + + while ble.connected: + packet = Packet.from_stream(uart_server) + if isinstance(packet, ColorPacket): + print(packet.color) + elif isinstance(packet, RawTextPacket): + print("Received Raw Text Packet:") + print(packet.text) diff --git a/examples/bluefruitconnect_uart.py b/examples/bluefruitconnect_uart.py index 2bbbf43..d73ae67 100644 --- a/examples/bluefruitconnect_uart.py +++ b/examples/bluefruitconnect_uart.py @@ -7,6 +7,7 @@ # will be displayed. Periodically, text is sent TO the connected device. import time + from adafruit_ble import BLERadio from adafruit_ble.advertising.standard import ProvideServicesAdvertisement from adafruit_ble.services.nordic import UARTService @@ -40,7 +41,7 @@ print("RX:", text) # OUTGOING (TX) periodically send text if time.monotonic() - last_send > SEND_RATE: - text = "COUNT = {}\r\n".format(count) + text = f"COUNT = {count}\r\n" print("TX:", text.strip()) uart_server.write(text.encode()) count += 1 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..8684faf --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,45 @@ +# SPDX-FileCopyrightText: 2022 Alec Delaney for Adafruit Industries +# +# SPDX-License-Identifier: MIT + +[build-system] +requires = [ + "setuptools", + "wheel", + "setuptools-scm", +] + +[project] +name = "adafruit-circuitpython-bluefruitconnect" +description = "CircuitPython library for use with the Adafruit Bluefruit Connect apps." +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_BluefruitConnect"} +keywords = [ + "adafruit", + "ble", + "bluefruit", + "bluetooth", + "micropython", + "circuitpython", +] +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_bluefruit_connect"] + +[tool.setuptools.dynamic] +dependencies = {file = ["requirements.txt"]} +optional-dependencies = {optional = {file = ["optional_requirements.txt"]}} diff --git a/requirements.txt b/requirements.txt index 17a850d..7a984a4 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,4 @@ -# SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries +# SPDX-FileCopyrightText: 2022 Alec Delaney, for Adafruit Industries # # SPDX-License-Identifier: Unlicense diff --git a/ruff.toml b/ruff.toml new file mode 100644 index 0000000..ecb20d0 --- /dev/null +++ b/ruff.toml @@ -0,0 +1,110 @@ +# 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 + "PLC2701", # private import + "UP006", # builtin instead of typing class + "UP007", # x | y typing +] + +[format] +line-ending = "lf" diff --git a/setup.py b/setup.py deleted file mode 100644 index 75a351e..0000000 --- a/setup.py +++ /dev/null @@ -1,56 +0,0 @@ -# SPDX-FileCopyrightText: 2021 ladyada 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 -""" - -# Always prefer setuptools over distutils -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-bluefruitconnect", - use_scm_version=True, - setup_requires=["setuptools_scm"], - description="CircuitPython library for use with the Adafruit Bluefruit Connect apps.", - long_description=long_description, - long_description_content_type="text/x-rst", - # The project's main homepage. - url="https://github.com/adafruit/Adafruit_CircuitPython_BluefruitConnect", - # Author details - author="Adafruit Industries", - author_email="circuitpython@adafruit.com", - install_requires=["Adafruit-Blinka"], - # 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", - "Programming Language :: Python :: 3.4", - "Programming Language :: Python :: 3.5", - ], - # What does your project relate to? - keywords="adafruit ble bluefruit bluetooth micropython circuitpython", - # You can just specify the packages manually here if your project is - # simple. Or you can use find_packages(). - packages=["adafruit_bluefruit_connect"], -) pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy