diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index fff3aa9..97fe64d 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 pylint black==19.10b0 Sphinx sphinx-rtd-theme - name: Library version run: git describe --dirty --always --tags - name: PyLint diff --git a/adafruit_bitmapsaver.py b/adafruit_bitmapsaver.py index fc503a5..1e5a69b 100644 --- a/adafruit_bitmapsaver.py +++ b/adafruit_bitmapsaver.py @@ -54,39 +54,44 @@ def _write_bmp_header(output_file, filesize): - output_file.write(bytes('BM', 'ascii')) - output_file.write(struct.pack('> 3) & 0x00FC red = (color >> 8) & 0x00F8 return (blue, green, red) -#pylint:disable=too-many-locals + +# pylint:disable=too-many-locals def _write_pixels(output_file, pixel_source, palette): saving_bitmap = isinstance(pixel_source, Bitmap) width, height = _rotated_height_and_width(pixel_source) @@ -96,14 +101,14 @@ def _write_pixels(output_file, pixel_source, palette): buffer_index = 0 if saving_bitmap: for x in range(width): - pixel = pixel_source[x, y-1] + pixel = pixel_source[x, y - 1] color = palette[pixel] for _ in range(3): row_buffer[buffer_index] = color & 0xFF color >>= 8 buffer_index += 1 else: - data = pixel_source.fill_row(y-1, result_buffer) + data = pixel_source.fill_row(y - 1, result_buffer) for i in range(width): pixel565 = (data[i * 2] << 8) + data[i * 2 + 1] for b in _rgb565_to_bgr_tuple(pixel565): @@ -111,7 +116,10 @@ def _write_pixels(output_file, pixel_source, palette): buffer_index += 1 output_file.write(row_buffer) gc.collect() -#pylint:enable=too-many-locals + + +# pylint:enable=too-many-locals + def save_pixels(file_or_filename, pixel_source=board.DISPLAY, palette=None): """Save pixels to a 24 bit per pixel BMP file. @@ -124,12 +132,12 @@ def save_pixels(file_or_filename, pixel_source=board.DISPLAY, palette=None): """ if isinstance(pixel_source, Bitmap): if not isinstance(palette, Palette): - raise ValueError('Third argument must be a Palette for a Bitmap save') + raise ValueError("Third argument must be a Palette for a Bitmap save") elif not isinstance(pixel_source, Display): - raise ValueError('Second argument must be a Bitmap or Display') + raise ValueError("Second argument must be a Bitmap or Display") try: if isinstance(file_or_filename, str): - output_file = open(file_or_filename, 'wb') + output_file = open(file_or_filename, "wb") else: output_file = file_or_filename diff --git a/docs/conf.py b/docs/conf.py index c37ef70..32acf88 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 = ["displayio", "digitalio", "busio", "board"] -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 BitmapSaver Library' -copyright = u'2019 Dave Astels' -author = u'Dave Astels' +project = "Adafruit BitmapSaver Library" +copyright = "2019 Dave Astels" +author = "Dave Astels" # 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 = "1.0" # The full version, including alpha/beta/rc tags. -release = u'1.0' +release = "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 = 'AdafruitBitmapsaverLibrarydoc' +htmlhelp_basename = "AdafruitBitmapsaverLibrarydoc" # -- 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, 'AdafruitBitmapSaverLibrary.tex', u'AdafruitBitmapSaver Library Documentation', - author, 'manual'), + ( + master_doc, + "AdafruitBitmapSaverLibrary.tex", + "AdafruitBitmapSaver 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, 'AdafruitBitmapSaverlibrary', u'Adafruit BitmapSaver Library Documentation', - [author], 1) + ( + master_doc, + "AdafruitBitmapSaverlibrary", + "Adafruit BitmapSaver 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, 'AdafruitBitmapSaverLibrary', u'Adafruit BitmapSaver Library Documentation', - author, 'AdafruitBitmapSaverLibrary', 'One line description of project.', - 'Miscellaneous'), + ( + master_doc, + "AdafruitBitmapSaverLibrary", + "Adafruit BitmapSaver Library Documentation", + author, + "AdafruitBitmapSaverLibrary", + "One line description of project.", + "Miscellaneous", + ), ] diff --git a/examples/bitmapsaver_screenshot_simpletest.py b/examples/bitmapsaver_screenshot_simpletest.py index f6ef016..d3ab904 100644 --- a/examples/bitmapsaver_screenshot_simpletest.py +++ b/examples/bitmapsaver_screenshot_simpletest.py @@ -22,7 +22,7 @@ """Example of taking a screenshot.""" -#pylint:disable=invalid-name +# pylint:disable=invalid-name import board import digitalio import busio @@ -37,6 +37,6 @@ vfs = storage.VfsFat(sdcard) storage.mount(vfs, "/sd") -print('Taking Screenshot...') -save_pixels('/sd/screenshot.bmp') -print('Screenshot taken') +print("Taking Screenshot...") +save_pixels("/sd/screenshot.bmp") +print("Screenshot taken") diff --git a/examples/bitmapsaver_simpletest.py b/examples/bitmapsaver_simpletest.py index fb5822d..b384e20 100644 --- a/examples/bitmapsaver_simpletest.py +++ b/examples/bitmapsaver_simpletest.py @@ -30,9 +30,9 @@ import storage from adafruit_bitmapsaver import save_pixels -#pylint:disable=invalid-name +# pylint:disable=invalid-name -print('Setting up SD card') +print("Setting up SD card") spi = busio.SPI(board.SCK, MOSI=board.MOSI, MISO=board.MISO) cs = digitalio.DigitalInOut(board.SD_CS) sdcard = adafruit_sdcard.SDCard(spi, cs) @@ -51,7 +51,7 @@ colors = (BLACK, RED, ORANGE, YELLOW, GREEN, BLUE, PURPLE, WHITE) -print('Building sample bitmap and palette') +print("Building sample bitmap and palette") bitmap = Bitmap(16, 16, 9) palette = Palette(len(colors)) for i, c in enumerate(colors): @@ -68,5 +68,5 @@ else: bitmap[x, y] = 0 -print('Saving bitmap') -save_pixels('/sd/test.bmp', bitmap, palette) +print("Saving bitmap") +save_pixels("/sd/test.bmp", bitmap, palette) diff --git a/setup.py b/setup.py index 07f056b..3b5e49e 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,40 @@ 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-bitmapsaver', - + name="adafruit-circuitpython-bitmapsaver", use_scm_version=True, - setup_requires=['setuptools_scm'], - - description='Save a displayio.Bitmap (and associated displayio.Palette) into a BMP file.', + setup_requires=["setuptools_scm"], + description="Save a displayio.Bitmap (and associated displayio.Palette) into a BMP file.", 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_BitmapSaver', - + url="https://github.com/adafruit/Adafruit_CircuitPython_BitmapSaver", # 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 blinka circuitpython micropython bitmapsaver displayio', - + keywords="adafruit blinka circuitpython micropython bitmapsaver displayio", # 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=['adafruit_bitmapsaver'], + py_modules=["adafruit_bitmapsaver"], )