diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index bb1f4b8..5d7bbbf 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -40,7 +40,7 @@ jobs: source actions-ci/install.sh - name: Pip install pylint, black, & Sphinx run: | - pip install --force-reinstall pylint==1.9.2 black==19.10b0 Sphinx sphinx-rtd-theme + pip install --force-reinstall pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/docs/conf.py b/docs/conf.py index 51fe575..73fc49f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -2,7 +2,8 @@ import os import sys -sys.path.insert(0, os.path.abspath('..')) + +sys.path.insert(0, os.path.abspath("..")) # -- General configuration ------------------------------------------------ @@ -10,10 +11,10 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', - 'sphinx.ext.napoleon', - 'sphinx.ext.todo', + "sphinx.ext.autodoc", + "sphinx.ext.intersphinx", + "sphinx.ext.napoleon", + "sphinx.ext.todo", ] # TODO: Please Read! @@ -23,29 +24,36 @@ # autodoc_mock_imports = ["digitalio", "busio"] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'BusDevice': ('https://circuitpython.readthedocs.io/projects/busdevice/en/latest/', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +intersphinx_mapping = { + "python": ("https://docs.python.org/3.4", None), + "BusDevice": ( + "https://circuitpython.readthedocs.io/projects/busdevice/en/latest/", + None, + ), + "CircuitPython": ("https://circuitpython.readthedocs.io/en/latest/", None), +} # Add any paths that contain templates here, relative to this directory. -templates_path = ['_templates'] +templates_path = ["_templates"] -source_suffix = '.rst' +source_suffix = ".rst" # The master toctree document. -master_doc = 'index' +master_doc = "index" # General information about the project. -project = u'Adafruit NeoPixel_SPI Library' -copyright = u'2019 Carter Nelson' -author = u'Carter Nelson' +project = u"Adafruit NeoPixel_SPI Library" +copyright = u"2019 Carter Nelson" +author = u"Carter Nelson" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = u'1.0' +version = u"1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = u"1.0" # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -57,7 +65,7 @@ # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. # This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '.env', 'CODE_OF_CONDUCT.md'] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", ".env", "CODE_OF_CONDUCT.md"] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -69,7 +77,7 @@ add_function_parentheses = True # The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' +pygments_style = "sphinx" # If true, `todo` and `todoList` produce output, else they produce nothing. todo_include_todos = False @@ -84,59 +92,62 @@ # 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' +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(), '.'] + + html_theme = "sphinx_rtd_theme" + html_theme_path = [sphinx_rtd_theme.get_html_theme_path(), "."] except: - html_theme = 'default' - html_theme_path = ['.'] + html_theme = "default" + html_theme_path = ["."] else: - html_theme_path = ['.'] + html_theme_path = ["."] # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ['_static'] +html_static_path = ["_static"] # The name of an image file (relative to this directory) to use as a favicon of # the docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. # -html_favicon = '_static/favicon.ico' +html_favicon = "_static/favicon.ico" # Output file base name for HTML help builder. -htmlhelp_basename = 'AdafruitNeopixel_spiLibrarydoc' +htmlhelp_basename = "AdafruitNeopixel_spiLibrarydoc" # -- Options for LaTeX output --------------------------------------------- latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'AdafruitNeoPixel_SPILibrary.tex', u'AdafruitNeoPixel_SPI Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitNeoPixel_SPILibrary.tex", + u"AdafruitNeoPixel_SPI Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +155,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitNeoPixel_SPIlibrary', u'Adafruit NeoPixel_SPI Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitNeoPixel_SPIlibrary", + u"Adafruit NeoPixel_SPI Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +170,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitNeoPixel_SPILibrary', u'Adafruit NeoPixel_SPI Library Documentation', - author, 'AdafruitNeoPixel_SPILibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitNeoPixel_SPILibrary", + u"Adafruit NeoPixel_SPI Library Documentation", + author, + "AdafruitNeoPixel_SPILibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/neopixel_spi_simpletest.py b/examples/neopixel_spi_simpletest.py index 3757406..2c724a7 100644 --- a/examples/neopixel_spi_simpletest.py +++ b/examples/neopixel_spi_simpletest.py @@ -9,10 +9,9 @@ spi = board.SPI() -pixels = neopixel.NeoPixel_SPI(spi, - NUM_PIXELS, - pixel_order=PIXEL_ORDER, - auto_write=False) +pixels = neopixel.NeoPixel_SPI( + spi, NUM_PIXELS, pixel_order=PIXEL_ORDER, auto_write=False +) while True: for color in COLORS: diff --git a/neopixel_spi.py b/neopixel_spi.py index 639813a..95345fe 100644 --- a/neopixel_spi.py +++ b/neopixel_spi.py @@ -43,22 +43,23 @@ * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice """ -from adafruit_pypixelbuf import PixelBuf, fill from adafruit_bus_device.spi_device import SPIDevice +from adafruit_pypixelbuf import PixelBuf, fill __version__ = "0.0.0-auto.0" __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel_SPI.git" # Pixel color order constants -RGB = 'RGB' +RGB = "RGB" """Red Green Blue""" -GRB = 'GRB' +GRB = "GRB" """Green Red Blue""" -RGBW = 'RGBW' +RGBW = "RGBW" """Red Green Blue White""" -GRBW = 'GRBW' +GRBW = "GRBW" """Green Red Blue White""" + class NeoPixel_SPI(PixelBuf): """ A sequence of neopixels. @@ -84,9 +85,11 @@ class NeoPixel_SPI(PixelBuf): """ FREQ = 6400000 # 800kHz * 8, actual may be different - TRST = 80e-6 # Reset code low level time + TRST = 80e-6 # Reset code low level time - def __init__(self, spi, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_order=None): + def __init__( + self, spi, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_order=None + ): # configure bpp and pixel_order if not pixel_order: @@ -103,15 +106,18 @@ def __init__(self, spi, n, *, bpp=3, brightness=1.0, auto_write=True, pixel_orde except AttributeError: # use nominal freq = self.FREQ - self._reset = bytes([0]*round(freq * self.TRST / 8)) + self._reset = bytes([0] * round(freq * self.TRST / 8)) self.spibuf = bytearray(8 * n * bpp) # everything else taken care of by base class - super().__init__(n, bytearray(n * bpp), - brightness=brightness, - rawbuf=bytearray(n * bpp), - byteorder=pixel_order, - auto_write=auto_write) + super().__init__( + n, + bytearray(n * bpp), + brightness=brightness, + rawbuf=bytearray(n * bpp), + byteorder=pixel_order, + auto_write=auto_write, + ) def deinit(self): """Blank out the NeoPixels.""" @@ -122,7 +128,7 @@ def show(self): """Shows the new colors on the pixels themselves if they haven't already been autowritten.""" self._transmogrify() - #pylint: disable=no-member + # pylint: disable=no-member with self._spi as spi: # write out special byte sequence surrounded by RESET # leading RESET needed for cases where MOSI rests HI @@ -136,9 +142,9 @@ def _transmogrify(self): # MSB first for i in range(7, -1, -1): if byte >> i & 0x01: - self.spibuf[k] = 0b11110000 # A NeoPixel 1 bit + self.spibuf[k] = 0b11110000 # A NeoPixel 1 bit else: - self.spibuf[k] = 0b11000000 # A NeoPixel 0 bit + self.spibuf[k] = 0b11000000 # A NeoPixel 0 bit k += 1 def fill(self, color): diff --git a/setup.py b/setup.py index ccb2f5c..29dea3b 100644 --- a/setup.py +++ b/setup.py @@ -6,6 +6,7 @@ """ from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -13,53 +14,44 @@ 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: +with open(path.join(here, "README.rst"), encoding="utf-8") as f: long_description = f.read() setup( - name='adafruit-circuitpython-neopixel-spi', - + name="adafruit-circuitpython-neopixel-spi", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='SPI driven CircuitPython driver for neopixels.', + setup_requires=["setuptools_scm"], + description="SPI driven CircuitPython driver for neopixels.", long_description=long_description, - long_description_content_type='text/x-rst', - + long_description_content_type="text/x-rst", # The project's main homepage. - url='https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel_SPI', - + url="https://github.com/adafruit/Adafruit_CircuitPython_NeoPixel_SPI", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", install_requires=[ - 'Adafruit-Blinka', - 'adafruit-circuitpython-busdevice', - 'adafruit-circuitpython-pypixelbuf' + "Adafruit-Blinka", + "adafruit-circuitpython-busdevice", + "adafruit-circuitpython-pypixelbuf", ], - # Choose your license - license='MIT', - + 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', + "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 blinka circuitpython micropython neopixel_spi neopixel', - + keywords="adafruit blinka circuitpython micropython neopixel_spi neopixel", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER, # CHANGE `py_modules=['...']` TO `packages=['...']` - py_modules=['neopixel_spi'], + py_modules=["neopixel_spi"], )