diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..1dad804 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/adafruit_trellism4.py b/adafruit_trellism4.py index 4a7e2bd..343d17b 100644 --- a/adafruit_trellism4.py +++ b/adafruit_trellism4.py @@ -53,6 +53,7 @@ class _NeoPixelArray: """Creates a NeoPixel array for use in the ``TrellisM4Express`` class.""" + def __init__(self, pin, *, width, height, rotation=0): self._neopixel = neopixel.NeoPixel(pin, width * height, auto_write=True) if rotation % 90 != 0: @@ -243,11 +244,14 @@ class TrellisM4Express: time.sleep(0.08) current_press = pressed """ + def __init__(self, rotation=0): self._rotation = rotation # Define NeoPixels - self.pixels = _NeoPixelArray(board.NEOPIXEL, width=8, height=4, rotation=rotation) + self.pixels = _NeoPixelArray( + board.NEOPIXEL, width=8, height=4, rotation=rotation + ) """Sequence like object representing the 32 NeoPixels on the Trellis M4 Express, Provides a two dimensional representation of the NeoPixel grid. diff --git a/docs/conf.py b/docs/conf.py index 59f5e86..9374144 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,32 @@ # autodoc_mock_imports = ["neopixel"] -intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)} +intersphinx_mapping = { + "python": ("https://docs.python.org/3.4", 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 TrellisM4 Library' -copyright = u'2018 Scott Shawcroft' -author = u'Scott Shawcroft' +project = u"Adafruit TrellisM4 Library" +copyright = u"2018 Scott Shawcroft" +author = u"Scott Shawcroft" # 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 +61,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 +73,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 +88,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 = 'AdafruitTrellism4Librarydoc' +htmlhelp_basename = "AdafruitTrellism4Librarydoc" # -- 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, 'AdafruitTrellisM4Library.tex', u'AdafruitTrellisM4 Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitTrellisM4Library.tex", + u"AdafruitTrellisM4 Library Documentation", + author, + "manual", + ), ] # -- Options for manual page output --------------------------------------- @@ -144,8 +151,13 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - (master_doc, 'AdafruitTrellisM4library', u'Adafruit TrellisM4 Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitTrellisM4library", + u"Adafruit TrellisM4 Library Documentation", + [author], + 1, + ) ] # -- Options for Texinfo output ------------------------------------------- @@ -154,7 +166,13 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - (master_doc, 'AdafruitTrellisM4Library', u'Adafruit TrellisM4 Library Documentation', - author, 'AdafruitTrellisM4Library', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitTrellisM4Library", + u"Adafruit TrellisM4 Library Documentation", + author, + "AdafruitTrellisM4Library", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/trellism4_neopixel_simpletest.py b/examples/trellism4_neopixel_simpletest.py index 1381a47..8843140 100755 --- a/examples/trellism4_neopixel_simpletest.py +++ b/examples/trellism4_neopixel_simpletest.py @@ -20,7 +20,7 @@ def wheel(pos): for x in range(trellis.pixels.width): for y in range(trellis.pixels.height): - pixel_index = (((y * 8) + x) * 256 // 32) + pixel_index = ((y * 8) + x) * 256 // 32 trellis.pixels[x, y] = wheel(pixel_index & 255) @@ -31,14 +31,14 @@ def wheel(pos): if press: print("Pressed:", press) pixel = (press[1] * 8) + press[0] - pixel_index = (pixel * 256 // 32) + pixel_index = pixel * 256 // 32 trellis.pixels.fill(wheel(pixel_index & 255)) for release in current_press - pressed: if release: print("Released:", release) for x in range(trellis.pixels.width): for y in range(trellis.pixels.height): - pixel_index = (((y * 8) + x) * 256 // 32) + pixel_index = ((y * 8) + x) * 256 // 32 trellis.pixels[x, y] = wheel(pixel_index & 255) time.sleep(0.08) current_press = pressed diff --git a/examples/trellism4_neopixel_toggle.py b/examples/trellism4_neopixel_toggle.py index c593c8d..82de5ff 100755 --- a/examples/trellism4_neopixel_toggle.py +++ b/examples/trellism4_neopixel_toggle.py @@ -34,7 +34,7 @@ def wheel(pos): if not led_on[x][y]: print("Turning on:", press) - pixel_index = ((x + (y * 8)) * 256 // 32) + pixel_index = (x + (y * 8)) * 256 // 32 trellis.pixels[x, y] = wheel(pixel_index & 255) led_on[x][y] = True diff --git a/examples/trellism4_wavefile_synth/trellism4_wavefile_synth.py b/examples/trellism4_wavefile_synth/trellism4_wavefile_synth.py index dc9a354..a825f1d 100644 --- a/examples/trellism4_wavefile_synth/trellism4_wavefile_synth.py +++ b/examples/trellism4_wavefile_synth/trellism4_wavefile_synth.py @@ -14,11 +14,17 @@ # low brightness on the neopixles trellis.pixels.brightness = 0.05 # each musical note letter -note_letters = ['C', 'D', 'E', 'F', 'G', 'A', 'B'] +note_letters = ["C", "D", "E", "F", "G", "A", "B"] # colors of the rainbow colors = [ - (255, 0, 0), (255, 127, 0), (255, 255, 0), - (0, 255, 0), (0, 0, 255), (56, 43, 105), (139, 0, 255)] + (255, 0, 0), + (255, 127, 0), + (255, 255, 0), + (0, 255, 0), + (0, 0, 255), + (56, 43, 105), + (139, 0, 255), +] # dictionary holding note string to wave file value. # e.g. {... "sined4": audioio.WaveFile(open("notes/sine/d4.wav")), ...} @@ -39,15 +45,19 @@ # add wave file to dictionary key = "{}{}".format(wave_type, cur_note) notes[key] = WaveFile( - open("notes/{}/{}.wav".format(wave_type, cur_note), "rb")) + open("notes/{}/{}.wav".format(wave_type, cur_note), "rb") + ) # main audio object audio = AudioOut(left_channel=board.A0, right_channel=board.A1) # mixer to allow pylyphonic playback mixer = Mixer( - voice_count=8, sample_rate=8000, - channel_count=2, bits_per_sample=16, - samples_signed=True) + voice_count=8, + sample_rate=8000, + channel_count=2, + bits_per_sample=16, + samples_signed=True, +) audio.play(mixer) @@ -79,7 +89,7 @@ # if we aren't already playing this note and we have available voice if key not in used_voices.keys() and available_voices: # build not string - note_for_key = "{}{}".format(note_letters[key[0]], key[1]+3) + note_for_key = "{}{}".format(note_letters[key[0]], key[1] + 3) note_to_play = "{}{}".format(current_wave_type, note_for_key) # if the note exists in the notes dictionary if note_to_play in notes: diff --git a/setup.py b/setup.py index 0d03e9e..924f98b 100644 --- a/setup.py +++ b/setup.py @@ -7,6 +7,7 @@ # Always prefer setuptools over distutils from setuptools import setup, find_packages + # To use a consistent encoding from codecs import open from os import path @@ -14,47 +15,38 @@ 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-trellism4', - + name="adafruit-circuitpython-trellism4", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython library Trellis M4 Express.', + setup_requires=["setuptools_scm"], + description="CircuitPython library Trellis M4 Express.", 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_TrellisM4', - + url="https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=['Adafruit-Blinka'], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka"], # 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 trellism4 hardware micropython circuitpython', - + keywords="adafruit trellism4 hardware micropython circuitpython", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). - py_modules=['adafruit_trellism4'], -) \ No newline at end of file + py_modules=["adafruit_trellism4"], +)