Merge pull request #12 from mrmcwethy/relint

 relinted to match cookiecutter

Author: tannewt

.gitignore

@@ -1,4 +1,7 @@
 .DS_Store
+__pycache__
+_build
+*.pyc
 .env
 build*
 bundles

.pylintrc

@@ -119,7 +119,8 @@ spelling-store-unknown-words=no
 [MISCELLANEOUS]
 
 # List of note tags to take in consideration, separated by a comma.
-notes=FIXME,XXX,TODO
+# notes=FIXME,XXX,TODO
+notes=FIXME,XXX
 
 
 [TYPECHECK]

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Radomir Dopieralski and Adafruit Industries
+Copyright (c) 2017 Radomir Dopieralski and Adafruit Industries
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.rst

@@ -1,5 +1,13 @@
-Display drivers for Adafruit CircuitPython.
-=========================================
+Introduction
+============
+
+.. image:: https://readthedocs.org/projects/adafruit-circuitpython-rgb_display/badge/?version=latest
+    :target: https://circuitpython.readthedocs.io/projects/rgb_display/en/latest/
+    :alt: Documentation Status
+
+.. image :: https://img.shields.io/discord/327254708534116352.svg
+    :target: https://discord.gg/nBQh6qu
+    :alt: Discord
 
 Port of display drivers from https://github.com/adafruit/micropython-adafruit-rgb-display
 to Adafruit CircuitPython for use on Adafruit's SAMD21-based and other CircuitPython
@@ -10,3 +18,89 @@ board too: https://github.com/adafruit/Adafruit_MicroPython_BusDevice
 
 Note that this driver currently won't work on micropython.org firmware, instead
 you want the micropython-adafruit-rgb-display driver linked above!
+
+Dependencies
+=============
+This driver depends on:
+
+* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
+
+Please ensure all dependencies are available on the CircuitPython filesystem.
+This is easily achieved by downloading
+`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
+
+Usage Example
+=============
+
+.. code-block:: python
+
+  import busio
+  import digitalio
+  from board import SCK, MOSI, MISO, D2, D2
+
+  from adafruit_rgb_display import color565
+  import adafruit_rgb_display.ili9341 as ili9341
+
+
+  # Configuration for CS and DC pins:
+  CS_PIN = D2
+  DC_PIN = D3
+
+  # Setup SPI bus using hardware SPI:
+  spi = busio.SPI(clock=SCK, MOSI=MOSI, MISO=MISO)
+
+  # Create the ILI9341 display:
+  display = ili9341.ILI9341(spi, cs=digitalio.DigitalInOut(CS_PIN),
+                            dc=digitalio.DigitalInOut(DC_PIN))
+
+  # Main loop:
+  while True:
+      # Clear the display
+      display.fill(0)
+      # Draw a red pixel in the center.
+      display.pixel(120, 160, color565(255, 0, 0))
+      # Pause 2 seconds.
+      time.sleep(2)
+      # Clear the screen blue.
+      display.fill(color565(0, 0, 255))
+      # Pause 2 seconds.
+  time.sleep(2)
+
+API Reference
+=============
+
+.. toctree::
+   :maxdepth: 2
+
+   api
+
+Contributing
+============
+
+Contributions are welcome! Please read our `Code of Conduct
+<https://github.com/adafruit/Adafruit_CircuitPython_RGB_Display/blob/master/CODE_OF_CONDUCT.md>`_
+before contributing to help this project stay welcoming.
+
+Building locally
+================
+
+To build this library locally you'll need to install the
+`circuitpython-build-tools <https://github.com/adafruit/circuitpython-build-tools>`_ package.
+
+.. code-block:: shell
+
+    python3 -m venv .env
+    source .env/bin/activate
+    pip install circuitpython-build-tools
+
+Once installed, make sure you are in the virtual environment:
+
+.. code-block:: shell
+
+    source .env/bin/activate
+
+Then run the build:
+
+.. code-block:: shell
+
+    circuitpython-build-bundles --filename_prefix adafruit-circuitpython-rgb_display --library_location .

adafruit_rgb_display/hx8353.py

@@ -1,4 +1,32 @@
-"""A simple driver for the HX8353-based displays."""
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Radomir Dopieralski and Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_RGB_Display.hx8353`
+====================================================
+
+A simple driver for the HX8353-based displays.
+
+* Author(s): Radomir Dopieralski, Michael McWethy
+"""
 from adafruit_rgb_display.rgb import DisplaySPI
 from micropython import const
 

adafruit_rgb_display/ili9341.py

@@ -1,4 +1,32 @@
-"""A simple driver for the ILI9341/ILI9340-based displays."""
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Radomir Dopieralski and Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_RGB_Display.ili9341`
+====================================================
+
+A simple driver for the ILI9341/ILI9340-based displays.
+
+* Author(s): Radomir Dopieralski, Michael McWethy
+"""
 
 try:
     import struct

adafruit_rgb_display/rgb.py

@@ -1,4 +1,33 @@
-""" Base class for all RGB Display devices """
+# The MIT License (MIT)
+#
+# Copyright (c) 2017 Radomir Dopieralski and Adafruit Industries
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""
+`adafruit_RGB_Display.rgb`
+====================================================
+
+Base class for all RGB Display devices
+
+* Author(s): Radomir Dopieralski, Michael McWethy
+"""
+
 import time
 from micropython import const
 try:
@@ -17,12 +46,14 @@
 
 
 def color565(r, g, b):
-    """Format color code for device"""
+    """Convert red, green and blue values (0-255) into a 16-bit 565 encoding.  As
+    a convenience this is also available in the parent adafruit_rgb_display
+    package namespace."""
     return (r & 0xf8) << 8 | (g & 0xfc) << 3 | b >> 3
 
 
 class DummyPin:
-    """A fake gpio pin for when you want to skip pins."""
+    """Can be used in place of a ``Pin()`` when you don't want to skip it."""
     def init(self, *args, **kwargs):
         """Dummy Pin init"""
         pass
@@ -37,7 +68,10 @@ def high(self):
 
 
 class Display: #pylint: disable-msg=no-member
-    """Base class for all RGB display devices"""
+    """Base class for all RGB display devices
+        :param width: number of pixels wide
+        :param height: number of pixels high
+    """
     _PAGE_SET = None
     _COLUMN_SET = None
     _RAM_WRITE = None
@@ -83,7 +117,7 @@ def _decode_pixel(self, data):
         return color565(*struct.unpack(self._DECODE_PIXEL, data))
 
     def pixel(self, x, y, color=None):
-        """Read or write a pixel."""
+        """Read or write a pixel at a given position."""
         if color is None:
             return self._decode_pixel(self._block(x, y, x, y))
 
@@ -93,7 +127,8 @@ def pixel(self, x, y, color=None):
 
     #pylint: disable-msg=too-many-arguments
     def fill_rectangle(self, x, y, width, height, color):
-        """Draw a filled rectangle."""
+        """Draw a rectangle at specified position with specified width and
+        height, and fill it with the specified color."""
         x = min(self.width - 1, max(0, x))
         y = min(self.height - 1, max(0, y))
         width = min(self.width - x, max(1, width))
@@ -109,7 +144,7 @@ def fill_rectangle(self, x, y, width, height, color):
     #pylint: enable-msg=too-many-arguments
 
     def fill(self, color=0):
-        """Fill whole screen."""
+        """Fill the whole display with the specified color."""
         self.fill_rectangle(0, 0, self.width, self.height, color)
 
     def hline(self, x, y, width, color):