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_sharpmemorydisplay.py b/adafruit_sharpmemorydisplay.py index 7453b57..1de220c 100644 --- a/adafruit_sharpmemorydisplay.py +++ b/adafruit_sharpmemorydisplay.py @@ -56,13 +56,14 @@ _SHARPMEM_BIT_VCOM = const(0x40) # in lsb _SHARPMEM_BIT_CLEAR = const(0x20) # in lsb + def reverse_bit(num): """Turn an LSB byte to an MSB byte, and vice versa. Used for SPI as it is LSB for the SHARP, but 99% of SPI implementations are MSB only!""" result = 0 for _ in range(8): result <<= 1 - result += (num & 1) + result += num & 1 num >>= 1 return result @@ -70,6 +71,7 @@ def reverse_bit(num): class SharpMemoryDisplay(adafruit_framebuf.FrameBuffer): """A driver for sharp memory displays, you can use any size but the full display must be buffered in memory!""" + # pylint: disable=too-many-instance-attributes,abstract-method def __init__(self, spi, scs_pin, width, height, *, baudrate=8000000): @@ -108,11 +110,11 @@ def show(self): self._spi.write(self._buf) slice_from = 0 - line_len = self.width//8 + line_len = self.width // 8 for line in range(self.height): - self._buf[0] = reverse_bit(line+1) + self._buf[0] = reverse_bit(line + 1) self._spi.write(self._buf) - self._spi.write(memoryview(self.buffer[slice_from:slice_from+line_len])) + self._spi.write(memoryview(self.buffer[slice_from : slice_from + line_len])) slice_from += line_len self._buf[0] = 0 self._spi.write(self._buf) diff --git a/docs/conf.py b/docs/conf.py index df6e48e..475ce08 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 = ["digitalio", "busio"] -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 SHARPMemoryDisplay Library' -copyright = u'2018 ladyada' -author = u'ladyada' +project = u"Adafruit SHARPMemoryDisplay Library" +copyright = u"2018 ladyada" +author = u"ladyada" # 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 = 'AdafruitSharpmemorydisplayLibrarydoc' +htmlhelp_basename = "AdafruitSharpmemorydisplayLibrarydoc" # -- 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, 'AdafruitSHARPMemoryDisplayLibrary.tex', u'AdafruitSHARPMemoryDisplay Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitSHARPMemoryDisplayLibrary.tex", + u"AdafruitSHARPMemoryDisplay 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, 'AdafruitSHARPMemoryDisplaylibrary', u'Adafruit SHARPMemoryDisplay Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitSHARPMemoryDisplaylibrary", + u"Adafruit SHARPMemoryDisplay 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, 'AdafruitSHARPMemoryDisplayLibrary', u'Adafruit SHARPMemoryDisplay Library Documentation', - author, 'AdafruitSHARPMemoryDisplayLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitSHARPMemoryDisplayLibrary", + u"Adafruit SHARPMemoryDisplay Library Documentation", + author, + "AdafruitSHARPMemoryDisplayLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/sharpmemorydisplay_pillow_demo.py b/examples/sharpmemorydisplay_pillow_demo.py index 96f47d8..b4bd9cb 100644 --- a/examples/sharpmemorydisplay_pillow_demo.py +++ b/examples/sharpmemorydisplay_pillow_demo.py @@ -22,9 +22,9 @@ FONTSIZE = 10 spi = busio.SPI(board.SCK, MOSI=board.MOSI) -scs = digitalio.DigitalInOut(board.D6) # inverted chip select +scs = digitalio.DigitalInOut(board.D6) # inverted chip select -#display = adafruit_sharpmemorydisplay.SharpMemoryDisplay(spi, scs, 96, 96) +# display = adafruit_sharpmemorydisplay.SharpMemoryDisplay(spi, scs, 96, 96) display = adafruit_sharpmemorydisplay.SharpMemoryDisplay(spi, scs, 144, 168) # Clear display. @@ -33,7 +33,7 @@ # Create blank image for drawing. # Make sure to create image with mode '1' for 1-bit color. -image = Image.new('1', (display.width, display.height)) +image = Image.new("1", (display.width, display.height)) # Get drawing object to draw on image. draw = ImageDraw.Draw(image) @@ -42,17 +42,24 @@ draw.rectangle((0, 0, display.width, display.height), outline=BLACK, fill=BLACK) # Draw a smaller inner rectangle -draw.rectangle((BORDER, BORDER, display.width - BORDER - 1, display.height - BORDER - 1), - outline=WHITE, fill=WHITE) +draw.rectangle( + (BORDER, BORDER, display.width - BORDER - 1, display.height - BORDER - 1), + outline=WHITE, + fill=WHITE, +) # Load a TTF font. -font = ImageFont.truetype('/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf', FONTSIZE) +font = ImageFont.truetype("/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf", FONTSIZE) # Draw Some Text text = "Hello World!" (font_width, font_height) = font.getsize(text) -draw.text((display.width//2 - font_width//2, display.height//2 - font_height//2), - text, font=font, fill=BLACK) +draw.text( + (display.width // 2 - font_width // 2, display.height // 2 - font_height // 2), + text, + font=font, + fill=BLACK, +) # Display image display.image(image) diff --git a/examples/sharpmemorydisplay_simpletest.py b/examples/sharpmemorydisplay_simpletest.py index a8b8b4d..5a2fa2b 100644 --- a/examples/sharpmemorydisplay_simpletest.py +++ b/examples/sharpmemorydisplay_simpletest.py @@ -7,7 +7,7 @@ # Initialize SPI bus and control pins spi = busio.SPI(board.SCK, MOSI=board.MOSI) -scs = digitalio.DigitalInOut(board.D6) # inverted chip select +scs = digitalio.DigitalInOut(board.D6) # inverted chip select # pass in the display size, width and height, as well # display = adafruit_sharpmemorydisplay.SharpMemoryDisplay(spi, scs, 96, 96) @@ -23,22 +23,25 @@ # Set a pixel in the origin 0,0 position. display.pixel(0, 0, 0) # Set a pixel in the middle position. -display.pixel(display.width//2, display.width//2, 0) +display.pixel(display.width // 2, display.width // 2, 0) # Set a pixel in the opposite corner position. -display.pixel(display.width-1, display.height-1, 0) +display.pixel(display.width - 1, display.height - 1, 0) display.show() time.sleep(2) print("Lines test") # we'll draw from corner to corner, lets define all the pair coordinates here -corners = ((0, 0), (0, display.height-1), (display.width-1, 0), - (display.width-1, display.height-1)) +corners = ( + (0, 0), + (0, display.height - 1), + (display.width - 1, 0), + (display.width - 1, display.height - 1), +) display.fill(1) for corner_from in corners: for corner_to in corners: - display.line(corner_from[0], corner_from[1], - corner_to[0], corner_to[1], 0) + display.line(corner_from[0], corner_from[1], corner_to[0], corner_to[1], 0) display.show() time.sleep(2) @@ -47,16 +50,16 @@ w_delta = display.width / 10 h_delta = display.height / 10 for i in range(11): - display.rect(0, 0, int(w_delta*i), int(h_delta*i), 0) + display.rect(0, 0, int(w_delta * i), int(h_delta * i), 0) display.show() time.sleep(2) print("Text test") display.fill(1) -display.text(' hello world!', 0, 0, 0) -display.text(' This is the', 0, 8, 0) -display.text(' CircuitPython', 0, 16, 0) -display.text('adafruit library', 0, 24, 0) -display.text(' for the SHARP', 0, 32, 0) -display.text(' Memory Display :) ', 0, 40, 0) +display.text(" hello world!", 0, 0, 0) +display.text(" This is the", 0, 8, 0) +display.text(" CircuitPython", 0, 16, 0) +display.text("adafruit library", 0, 24, 0) +display.text(" for the SHARP", 0, 32, 0) +display.text(" Memory Display :) ", 0, 40, 0) display.show() diff --git a/setup.py b/setup.py index 5ed523e..6fd1811 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-sharpmemorydisplay', - + name="adafruit-circuitpython-sharpmemorydisplay", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='CircuitPython display control library for Sharp memory displays.', + setup_requires=["setuptools_scm"], + description="CircuitPython display control library for Sharp memory displays.", 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_SharpMemoryDisplay', - + url="https://github.com/adafruit/Adafruit_CircuitPython_SharpMemoryDisplay", # Author details - author='Adafruit Industries', - author_email='circuitpython@adafruit.com', - - install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-framebuf'], - + author="Adafruit Industries", + author_email="circuitpython@adafruit.com", + install_requires=["Adafruit-Blinka", "adafruit-circuitpython-framebuf"], # 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 sharp memory display hardware micropython circuitpython', - + keywords="adafruit sharp memory display 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_sharpmemorydisplay'], -) \ No newline at end of file + py_modules=["adafruit_sharpmemorydisplay"], +)