adafruit-circuitpython-si5351 1.4.5__tar.gz → 1.4.7__tar.gz

adafruit_circuitpython_si5351-1.4.7/.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

adafruit_circuitpython_si5351-1.4.7/.pre-commit-config.yaml

@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: 2024 Justin Myers for Adafruit Industries
+#
+# SPDX-License-Identifier: Unlicense
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v4.5.0
+    hooks:
+      - 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: ruff-format
+      - id: ruff
+        args: ["--fix"]
+  - repo: https://github.com/fsfe/reuse-tool
+    rev: v3.0.1
+    hooks:
+      - id: reuse

{adafruit_circuitpython_si5351-1.4.5 → adafruit_circuitpython_si5351-1.4.7}/.readthedocs.yaml

@@ -8,6 +8,9 @@
 # Required
 version: 2
 
+sphinx:
+  configuration: docs/conf.py
+
 build:
   os: ubuntu-20.04
   tools:

{adafruit_circuitpython_si5351-1.4.5 → adafruit_circuitpython_si5351-1.4.7}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: adafruit-circuitpython-si5351
-Version: 1.4.5
+Version: 1.4.7
 Summary: CircuitPython library for SI5351 clock generator module.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT
@@ -17,6 +17,7 @@ License-File: LICENSE
 Requires-Dist: Adafruit-Blinka
 Requires-Dist: adafruit-circuitpython-busdevice
 Provides-Extra: optional
+Dynamic: license-file
 
 Introduction
 ============
@@ -33,9 +34,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_SI5351/actions/
     :alt: Build Status
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. 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
 
 SI5351 clock generator module.
 

{adafruit_circuitpython_si5351-1.4.5 → adafruit_circuitpython_si5351-1.4.7}/README.rst

@@ -13,9 +13,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_SI5351/actions/
     :alt: Build Status
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. 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
 
 SI5351 clock generator module.
 

{adafruit_circuitpython_si5351-1.4.5 → adafruit_circuitpython_si5351-1.4.7}/adafruit_circuitpython_si5351.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: adafruit-circuitpython-si5351
-Version: 1.4.5
+Version: 1.4.7
 Summary: CircuitPython library for SI5351 clock generator module.
 Author-email: Adafruit Industries <circuitpython@adafruit.com>
 License: MIT
@@ -17,6 +17,7 @@ License-File: LICENSE
 Requires-Dist: Adafruit-Blinka
 Requires-Dist: adafruit-circuitpython-busdevice
 Provides-Extra: optional
+Dynamic: license-file
 
 Introduction
 ============
@@ -33,9 +34,9 @@ Introduction
     :target: https://github.com/adafruit/Adafruit_CircuitPython_SI5351/actions/
     :alt: Build Status
 
-.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code Style: Black
+.. 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
 
 SI5351 clock generator module.
 

{adafruit_circuitpython_si5351-1.4.5 → adafruit_circuitpython_si5351-1.4.7}/adafruit_circuitpython_si5351.egg-info/SOURCES.txt

@@ -1,6 +1,6 @@
+.gitattributes
 .gitignore
 .pre-commit-config.yaml
-.pylintrc
 .readthedocs.yaml
 CODE_OF_CONDUCT.md
 LICENSE
@@ -10,6 +10,7 @@ adafruit_si5351.py
 optional_requirements.txt
 pyproject.toml
 requirements.txt
+ruff.toml
 .github/PULL_REQUEST_TEMPLATE/adafruit_circuitpython_pr.md
 .github/workflows/build.yml
 .github/workflows/failure-help-text.yml

{adafruit_circuitpython_si5351-1.4.5 → adafruit_circuitpython_si5351-1.4.7}/adafruit_si5351.py

@@ -12,19 +12,20 @@ library at: https://github.com/adafruit/Adafruit_Si5351_Library/
 
 * Author(s): Tony DiCola
 """
-import math
 
-from micropython import const
+import math
 
 from adafruit_bus_device import i2c_device
+from micropython import const
 
 try:
-    import typing  # pylint: disable=unused-import
+    import typing
+
     from busio import I2C
 except ImportError:
     pass
 
-__version__ = "1.4.5"
+__version__ = "1.4.7"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_SI5351.git"
 
 
@@ -122,16 +123,13 @@ R_DIV_128 = 7
 # Disable invalid name because p1, p2, p3 variables are false positives.
 # These are legitimate register names and adding more characters obfuscates
 # the intention of the code.
-# pylint: disable=invalid-name
 
 # Disable protected access warning because inner classes by design need and use
 # access to protected members.
-# pylint: disable=protected-access
 
 # Another silly pylint check to disable, it has no context of the complexity
 # of R divider values and explicit unrolling of them into multiple if cases
 # and return statements.  Disable.
-# pylint: disable=too-many-return-statements
 
 
 class SI5351:
@@ -196,9 +194,7 @@ class SI5351:
             #   https://github.com/adafruit/circuitpython/issues/572
             self._frequency = fvco
 
-        def configure_fractional(
-            self, multiplier: int, numerator: int, denominator: int
-        ) -> None:
+        def configure_fractional(self, multiplier: int, numerator: int, denominator: int) -> None:
             """Configure the PLL with a fractional multiplier specified by
             multiplier and numerator/denominator.  This is less accurate and
             susceptible to jitter but allows a larger range of PLL frequencies.
@@ -206,22 +202,15 @@ class SI5351:
             if multiplier >= 91 or multiplier <= 14:
                 raise ValueError("Multiplier must be in range 14 to 91.")
             if denominator > 0xFFFFF or denominator <= 0:  # Prevent divide by zero.
-                raise ValueError(
-                    "Denominator must be greater than 0 and less than 0xFFFFF."
-                )
+                raise ValueError("Denominator must be greater than 0 and less than 0xFFFFF.")
             if numerator >= 0xFFFFF or numerator < 0:
                 raise ValueError("Numerator must be in range 0 to 0xFFFFF.")
             multiplier = int(multiplier)
             numerator = int(numerator)
             denominator = int(denominator)
             # Compute register values and configure them.
-            p1 = int(
-                128 * multiplier + math.floor(128 * ((numerator / denominator)) - 512)
-            )
-            p2 = int(
-                128 * numerator
-                - denominator * math.floor(128 * (numerator / denominator))
-            )
+            p1 = int(128 * multiplier + math.floor(128 * (numerator / denominator) - 512))
+            p2 = int(128 * numerator - denominator * math.floor(128 * (numerator / denominator)))
             p3 = denominator
             self._configure_registers(p1, p2, p3)
             # Calculate exact frequency and store it for reference.
@@ -251,7 +240,7 @@ class SI5351:
             self._divider = None
 
         @property
-        def frequency(self) -> float:
+        def frequency(self) -> float:  # noqa: PLR0911
             """Get the frequency of this clock output in hertz.  This is
             computed based on the configured PLL, clock divider, and R divider.
             """
@@ -263,7 +252,6 @@ class SI5351:
             base_frequency = self._pll.frequency / self._divider
             # And add a further division for the R divider if set.
             r_divider = self.r_divider
-            # pylint: disable=no-else-return
             # Disable should be removed when refactor can be tested.
             if r_divider == R_DIV_1:
                 return base_frequency
@@ -325,9 +313,7 @@ class SI5351:
                 buf[8] = p2 & 0x000000FF
                 i2c.write(buf, end=9)
 
-        def configure_integer(
-            self, pll: "PLL", divider: int, inverted: bool = False
-        ) -> None:
+        def configure_integer(self, pll: "PLL", divider: int, inverted: bool = False) -> None:
             """Configure the clock output with the specified PLL source
             (should be a PLL instance on the SI5351 class) and specific integer
             divider.  This is the most accurate way to set the clock output
@@ -371,13 +357,10 @@ class SI5351:
             fractional divider with numerator/denominator.  Again this is less
             accurate but has a wider range of output frequencies.
             """
-            # pylint: disable=too-many-arguments
             if divider >= 2049 or divider <= 3:
                 raise ValueError("Divider must be in range 3 to 2049.")
             if denominator > 0xFFFFF or denominator <= 0:  # Prevent divide by zero.
-                raise ValueError(
-                    "Denominator must be greater than 0 and less than 0xFFFFF."
-                )
+                raise ValueError("Denominator must be greater than 0 and less than 0xFFFFF.")
             if numerator >= 0xFFFFF or numerator < 0:
                 raise ValueError("Numerator must be in range 0 to 0xFFFFF.")
             divider = int(divider)
@@ -388,10 +371,7 @@ class SI5351:
                 raise RuntimeError("PLL must be configured.")
             # Compute MSx register values.
             p1 = int(128 * divider + math.floor(128 * (numerator / denominator)) - 512)
-            p2 = int(
-                128 * numerator
-                - denominator * math.floor(128 * (numerator / denominator))
-            )
+            p2 = int(128 * numerator - denominator * math.floor(128 * (numerator / denominator)))
             p3 = denominator
             self._configure_registers(p1, p2, p3)
             # Configure the clock control register.

adafruit_circuitpython_si5351-1.4.7/docs/api.rst

@@ -0,0 +1,11 @@
+
+.. If you created a package, create one automodule per module in the package.
+
+.. 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_si5351
+   :members:

{adafruit_circuitpython_si5351-1.4.5 → adafruit_circuitpython_si5351-1.4.7}/docs/conf.py

@@ -1,12 +1,10 @@
-# -*- coding: utf-8 -*-
-
 # SPDX-FileCopyrightText: 2021 ladyada for Adafruit Industries
 #
 # SPDX-License-Identifier: MIT
 
+import datetime
 import os
 import sys
-import datetime
 
 sys.path.insert(0, os.path.abspath(".."))
 
@@ -49,9 +47,7 @@ project = "Adafruit SI5351 Library"
 creation_year = "2017"
 current_year = str(datetime.datetime.now().year)
 year_duration = (
-    current_year
-    if current_year == creation_year
-    else creation_year + " - " + current_year
+    current_year if current_year == creation_year else creation_year + " - " + current_year
 )
 copyright = year_duration + " Tony DiCola"
 author = "Tony DiCola"

{adafruit_circuitpython_si5351-1.4.5 → adafruit_circuitpython_si5351-1.4.7}/examples/si5351_simpletest.py

@@ -16,7 +16,6 @@ import busio
 
 import adafruit_si5351
 
-
 # Initialize I2C bus.
 i2c = busio.I2C(board.SCL, board.SDA)
 
@@ -32,7 +31,7 @@ si5351 = adafruit_si5351.SI5351(i2c)
 # but allows less of a range of frequencies compared to a fractional
 # multiplier shown next.
 si5351.pll_a.configure_integer(36)  # Multiply 25mhz by 36
-print("PLL A frequency: {0}mhz".format(si5351.pll_a.frequency / 1000000))
+print(f"PLL A frequency: {si5351.pll_a.frequency / 1000000}mhz")
 
 # And next configure PLL B to 616.6667mhz by multiplying 25mhz by 24.667 using
 # the fractional multiplier configuration.  Notice you specify the integer
@@ -41,7 +40,7 @@ print("PLL A frequency: {0}mhz".format(si5351.pll_a.frequency / 1000000))
 # configuration is susceptible to some jitter over time but can set a larger
 # range of frequencies.
 si5351.pll_b.configure_fractional(24, 2, 3)  # Multiply 25mhz by 24.667 (24 2/3)
-print("PLL B frequency: {0}mhz".format(si5351.pll_b.frequency / 1000000))
+print(f"PLL B frequency: {si5351.pll_b.frequency / 1000000}mhz")
 
 # Now configure the clock outputs.  Each is driven by a PLL frequency as input
 # and then further divides that down to a specific frequency.
@@ -49,14 +48,14 @@ print("PLL B frequency: {0}mhz".format(si5351.pll_b.frequency / 1000000))
 # of 112.5mhz (900mhz / 8).  Again this uses the most precise integer division
 # but can't set as wide a range of values.
 si5351.clock_0.configure_integer(si5351.pll_a, 8)
-print("Clock 0: {0}mhz".format(si5351.clock_0.frequency / 1000000))
+print(f"Clock 0: {si5351.clock_0.frequency / 1000000}mhz")
 
 # Next configure clock 1 to be driven by PLL B divided by 45.5 to get
 # 13.5531mhz (616.6667mhz / 45.5).  This uses fractional division and again
 # notice the numerator and denominator are explicitly specified.  This is less
 # precise but allows a large range of frequencies.
 si5351.clock_1.configure_fractional(si5351.pll_b, 45, 1, 2)  # Divide by 45.5 (45 1/2)
-print("Clock 1: {0}mhz".format(si5351.clock_1.frequency / 1000000))
+print(f"Clock 1: {si5351.clock_1.frequency / 1000000}mhz")
 
 # Finally configure clock 2 to be driven by PLL B divided once by 900 to get
 # down to 685.15 khz and then further divided by a special R divider that
@@ -72,7 +71,7 @@ si5351.clock_2.configure_integer(si5351.pll_b, 900)
 #  - R_DIV_64: divider of 64
 #  - R_DIV_128: divider of 128
 si5351.clock_2.r_divider = adafruit_si5351.R_DIV_64
-print("Clock 2: {0}khz".format(si5351.clock_2.frequency / 1000))
+print(f"Clock 2: {si5351.clock_2.frequency / 1000}khz")
 
 # After configuring PLLs and clocks, enable the outputs.
 si5351.outputs_enabled = True

{adafruit_circuitpython_si5351-1.4.5 → adafruit_circuitpython_si5351-1.4.7}/pyproject.toml

@@ -12,7 +12,7 @@ requires = [
 [project]
 name = "adafruit-circuitpython-si5351"
 description = "CircuitPython library for SI5351 clock generator module."
-version = "1.4.5"
+version = "1.4.7"
 readme = "README.rst"
 authors = [
     {name = "Adafruit Industries", email = "circuitpython@adafruit.com"}

adafruit_circuitpython_si5351-1.4.7/ruff.toml

@@ -0,0 +1,106 @@
+# 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
+]
+
+[format]
+line-ending = "lf"

adafruit_circuitpython_si5351-1.4.5/.pre-commit-config.yaml

@@ -1,42 +0,0 @@
-# SPDX-FileCopyrightText: 2020 Diego Elio Pettenò
-#
-# SPDX-License-Identifier: Unlicense
-
-repos:
-  - repo: https://github.com/python/black
-    rev: 23.3.0
-    hooks:
-      - id: black
-  - repo: https://github.com/fsfe/reuse-tool
-    rev: v1.1.2
-    hooks:
-      - id: reuse
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
-    hooks:
-      - id: check-yaml
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
-  - repo: https://github.com/pycqa/pylint
-    rev: v2.17.4
-    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

adafruit_circuitpython_si5351-1.4.5/.pylintrc

@@ -1,399 +0,0 @@
-# SPDX-FileCopyrightText: 2017 Scott Shawcroft, written 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 ignore-list. They should be base names, not
-# paths.
-ignore=CVS
-
-# Add files or directories matching the regex patterns to the ignore-list. 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=pylint.extensions.no_self_use
-
-# 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,raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,deprecated-str-translate-call
-disable=raw-checker-failed,bad-inline-option,locally-disabled,file-ignored,suppressed-message,useless-suppression,deprecated-pragma,import-error,pointless-string-statement,unspecified-encoding
-
-# Enable the message, report, category or checker with the given id(s). You can
-# either give multiple identifier separated by comma (,) or put this option
-# 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*(# )?<?https?://\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
-
-# 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=12
-
-
-[BASIC]
-
-# Regular expression matching correct argument names
-argument-rgx=(([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
-
-# Regular expression matching correct class attribute names
-class-attribute-rgx=([A-Za-z_][A-Za-z0-9_]{2,30}|(__.*__))$
-
-# Regular expression matching correct class names
-# class-rgx=[A-Z_][a-zA-Z0-9]+$
-class-rgx=[A-Z_][a-zA-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
-
-# 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
-
-# Regular expression matching correct inline iteration names
-inlinevar-rgx=[A-Za-z_][A-Za-z0-9_]*$
-
-# Regular expression matching correct method names
-method-rgx=(([a-z][a-z0-9_]{2,30})|(_[a-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
-
-# 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=builtins.Exception

adafruit_circuitpython_si5351-1.4.5/docs/api.rst

@@ -1,5 +0,0 @@
-
-.. If you created a package, create one automodule per module in the package.
-
-.. automodule:: adafruit_si5351
-   :members: