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_gizmo/eink_gizmo.py b/adafruit_gizmo/eink_gizmo.py index 4ecb576..6afe940 100644 --- a/adafruit_gizmo/eink_gizmo.py +++ b/adafruit_gizmo/eink_gizmo.py @@ -44,7 +44,8 @@ class EInk_Gizmo(IL0373): def __init__(self, *, spi=None, cs=None, dc=None, reset=None, busy=None): displayio.release_displays() if spi is None: - import busio + import busio # pylint: disable=import-outside-toplevel + spi = busio.SPI(board.SCL, MOSI=board.SDA) if cs is None: cs = board.RX @@ -52,12 +53,15 @@ def __init__(self, *, spi=None, cs=None, dc=None, reset=None, busy=None): dc = board.TX if reset is None: reset = board.A3 - self._display_bus = displayio.FourWire(spi, - command=dc, - chip_select=cs, - reset=reset, - baudrate=1000000) + self._display_bus = displayio.FourWire( + spi, command=dc, chip_select=cs, reset=reset, baudrate=1000000 + ) sleep(1) - super().__init__(self._display_bus, width=152, height=152, - busy_pin=busy, rotation=180, - highlight_color=0xff0000) + super().__init__( + self._display_bus, + width=152, + height=152, + busy_pin=busy, + rotation=180, + highlight_color=0xFF0000, + ) diff --git a/adafruit_gizmo/tft_gizmo.py b/adafruit_gizmo/tft_gizmo.py index 9baaea5..04d5b9d 100755 --- a/adafruit_gizmo/tft_gizmo.py +++ b/adafruit_gizmo/tft_gizmo.py @@ -40,15 +40,20 @@ class TFT_Gizmo(ST7789): """Class representing a TFT Gizmo.""" - def __init__(self, *, spi=None, cs=board.RX, dc=board.TX, - backlight=board.A3, rotation=180): + def __init__( + self, *, spi=None, cs=board.RX, dc=board.TX, backlight=board.A3, rotation=180 + ): displayio.release_displays() if spi is None: - import busio + import busio # pylint: disable=import-outside-toplevel + spi = busio.SPI(board.SCL, MOSI=board.SDA) - self._display_bus = displayio.FourWire(spi, - command=dc, - chip_select=cs) - super().__init__(self._display_bus, width=240, height=240, - rowstart=80, backlight_pin=backlight, - rotation=rotation) + self._display_bus = displayio.FourWire(spi, command=dc, chip_select=cs) + super().__init__( + self._display_bus, + width=240, + height=240, + rowstart=80, + backlight_pin=backlight, + rotation=rotation, + ) diff --git a/docs/conf.py b/docs/conf.py index 984e87a..d7e8866 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 = ["adafruit_st7789", "digitalio", "busio", "displayio", "board"] -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 Gizmo Library' -copyright = u'2019 Carter Nelson' -author = u'Carter Nelson' +project = u"Adafruit Gizmo 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 = 'AdafruitGizmoLibrarydoc' +htmlhelp_basename = "AdafruitGizmoLibrarydoc" # -- 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, 'AdafruitGizmoLibrary.tex', u'AdafruitGizmo Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitGizmoLibrary.tex", + u"AdafruitGizmo 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, 'AdafruitGizmolibrary', u'Adafruit Gizmo Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitGizmolibrary", + u"Adafruit Gizmo 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, 'AdafruitGizmoLibrary', u'Adafruit Gizmo Library Documentation', - author, 'AdafruitGizmoLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitGizmoLibrary", + u"Adafruit Gizmo Library Documentation", + author, + "AdafruitGizmoLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/gizmo_simpletest.py b/examples/gizmo_simpletest.py index ae5b8d5..c6ee72d 100644 --- a/examples/gizmo_simpletest.py +++ b/examples/gizmo_simpletest.py @@ -15,7 +15,7 @@ # Create a two color palette palette = displayio.Palette(2) palette[0] = 0x000000 -palette[1] = 0xffffff +palette[1] = 0xFFFFFF # Create a TileGrid using the Bitmap and Palette tile_grid = displayio.TileGrid(bitmap, pixel_shader=palette) diff --git a/examples/gizmo_tft_demo.py b/examples/gizmo_tft_demo.py index 8df874f..94ade88 100644 --- a/examples/gizmo_tft_demo.py +++ b/examples/gizmo_tft_demo.py @@ -16,27 +16,23 @@ color_bitmap = displayio.Bitmap(240, 240, 1) color_palette = displayio.Palette(1) -color_palette[0] = 0x00FF00 # Bright Green +color_palette[0] = 0x00FF00 # Bright Green -bg_sprite = displayio.TileGrid(color_bitmap, - pixel_shader=color_palette, - x=0, y=0) +bg_sprite = displayio.TileGrid(color_bitmap, pixel_shader=color_palette, x=0, y=0) splash.append(bg_sprite) # Draw a smaller inner rectangle inner_bitmap = displayio.Bitmap(200, 200, 1) inner_palette = displayio.Palette(1) -inner_palette[0] = 0xAA0088 # Purple -inner_sprite = displayio.TileGrid(inner_bitmap, - pixel_shader=inner_palette, - x=20, y=20) +inner_palette[0] = 0xAA0088 # Purple +inner_sprite = displayio.TileGrid(inner_bitmap, pixel_shader=inner_palette, x=20, y=20) splash.append(inner_sprite) # Draw a label text_group = displayio.Group(max_size=10, scale=2, x=50, y=120) text = "Hello World!" text_area = label.Label(terminalio.FONT, text=text, color=0xFFFF00) -text_group.append(text_area) # Subgroup for text scaling +text_group.append(text_area) # Subgroup for text scaling splash.append(text_group) while True: diff --git a/examples/gizmo_tft_termometer.py b/examples/gizmo_tft_termometer.py index 8b366d9..c1b56be 100644 --- a/examples/gizmo_tft_termometer.py +++ b/examples/gizmo_tft_termometer.py @@ -15,6 +15,7 @@ import terminalio from adafruit_display_text import label from adafruit_gizmo import tft_gizmo + display = tft_gizmo.TFT_Gizmo() @@ -30,7 +31,7 @@ # function to convert celsius degrees to fahrenheit def c_to_f(c_val): - return (c_val * 9/5) + 32 + return (c_val * 9 / 5) + 32 # Open the background image file @@ -61,7 +62,7 @@ def c_to_f(c_val): text_area.anchor_point = (0.5, 0.0) # Set the location to center of display, accounting for text_scale - text_area.anchored_position = (240/(2*TEXT_SCALE), 240/(2*TEXT_SCALE)) + text_area.anchored_position = (240 / (2 * TEXT_SCALE), 240 / (2 * TEXT_SCALE)) # Subgroup for text scaling text_group.append(text_area) @@ -77,7 +78,7 @@ def c_to_f(c_val): # set current button state to variable cur_a_val = cp.button_a if cur_a_val and not old_a_val: # if the button was released - print('Just released') + print("Just released") # flip the units boolean to the opposite value show_c_units = not show_c_units diff --git a/setup.py b/setup.py index ce19be0..65edcdf 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,51 +14,42 @@ 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-gizmo', - + name="adafruit-circuitpython-gizmo", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython classes for Adafruit Gizmos', + setup_requires=["setuptools_scm"], + description="CircuitPython classes for Adafruit Gizmos", 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_Gizmo', - + url="https://github.com/adafruit/Adafruit_CircuitPython_Gizmo", # 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_st7789' + "Adafruit-Blinka", + "adafruit-circuitpython-busdevice", + "adafruit_st7789", ], - # 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 gizmo circuit playground', - + keywords="adafruit blinka circuitpython micropython gizmo circuit playground", # You can just specify the packages manually here if your project is # simple. Or you can use find_packages(). - packages=['adafruit_gizmo'], + packages=["adafruit_gizmo"], )