multiple fixes.

Author: ntavish

.travis.yml

@@ -11,9 +11,6 @@ python:
 cache:
   pip: true
 
-# TODO: if deployment to PyPi is desired, change 'DEPLOY_PYPI' to "true",
-#       or remove the env block entirely and remove the condition in the
-#       deploy block.
 env:
   - DEPLOY_PYPI="false"
 
@@ -26,8 +23,6 @@ deploy:
     overwrite: true
     on:
       tags: true
-  # TODO: Use 'travis encrypt --com -r adafruit/<repo slug>' to generate
-  #       the encrypted password for adafruit-travis. Paste result below.
   - provider: pypi
     user: adafruit-travis
     password:

README.rst

@@ -27,40 +27,28 @@ 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>`_.
 
-Installing from PyPI
-=====================
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
-   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
-
-On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
-PyPI <https://pypi.org/project/adafruit-circuitpython-lis2dh12/>`_. To install for current user:
-
-.. code-block:: shell
-
-    pip3 install adafruit-circuitpython-lis2dh12
-
-To install system-wide (this may be required in some cases):
-
-.. code-block:: shell
-
-    sudo pip3 install adafruit-circuitpython-lis2dh12
+Usage Example
+=============
 
-To install in a virtual environment in your current project:
+.. code-block:: python
 
-.. code-block:: shell
+    import time
+    import board
+    import busio
+    import electronutlabs_lis2dh12
 
-    mkdir project-name && cd project-name
-    python3 -m venv .env
-    source .env/bin/activate
-    pip3 install adafruit-circuitpython-lis2dh12
+    i2c = busio.I2C(board.SCL, board.SDA)
+    lis2dh12 = electronutlabs_lis2dh12.LIS2DH12_I2C(i2c, address=0x19)
 
-Usage Example
-=============
+    lis2dh12.range = electronutlabs_lis2dh12.RANGE_2_G
 
-.. todo:: Add a quick, simple example. It and other examples should live in the examples folder and be included in docs/examples.rst.
+    while True:
+        # Read accelerometer values (in m / s ^ 2).  Returns a 3-tuple of x, y,
+        # z axis values.  Divide them by 9.806 to convert to Gs.
+        x, y, z = [value / electronutlabs_lis2dh12.STANDARD_GRAVITY for value in lis2dh12.acceleration]
+        print("x = %0.3f G, y = %0.3f G, z = %0.3f G" % (x, y, z))
+        # Small delay to keep things responsive but give time for interrupt processing.
+        time.sleep(0.5)
 
 Contributing
 ============

docs/conf.py

@@ -16,11 +16,10 @@
     'sphinx.ext.todo',
 ]
 
-# TODO: Please Read!
 # Uncomment the below if you use native CircuitPython modules such as
 # digitalio, micropython and busio. List the modules you use. Without it, the
 # autodoc module docs will fail to generate with a warning.
-# autodoc_mock_imports = ["digitalio", "busio"]
+autodoc_mock_imports = ["micropython", "busio"]
 
 
 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)}

docs/index.rst

@@ -23,14 +23,11 @@ Table of Contents
 .. toctree::
     :caption: Tutorials
 
-.. todo:: Add any Learn guide links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
-
 .. toctree::
     :caption: Related Products
 
-.. todo:: Add any product links here. If there are none, then simply delete this todo and leave
-    the toctree above for use later.
+    * `ST Microelectronics LIS2DH12 chip <https://www.st.com/en/mems-and-sensors/lis2dh12.html>`_
+    * `Electronut Labs Blip <https://docs.electronut.in/blip/>`_
 
 .. toctree::
     :caption: Other Links

electronutlabs_lis2dh12.py

@@ -33,28 +33,24 @@
 
 **Hardware:**
 
-.. todo:: Add links to any specific hardware product page(s), or category page(s). Use unordered list & hyperlink rST
-   inline format: "* `Link Text <url>`_"
+* `ST Microelectronics LIS2DH12 chip
+  <https://www.st.com/en/mems-and-sensors/lis2dh12.html>`_
+* `Electronut Labs Blip <https://docs.electronut.in/blip/>`_
 
 **Software and Dependencies:**
 
 * Adafruit CircuitPython firmware for the supported boards:
   https://github.com/adafruit/circuitpython/releases
 
-.. todo:: Uncomment or remove the Bus Device and/or the Register library dependencies based on the library's use of either.
-
 # * Adafruit's Bus Device library: https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
-# * Adafruit's Register library: https://github.com/adafruit/Adafruit_CircuitPython_Register
 """
 
 # libray is similar to github.com/adafruit/Adafruit_CircuitPython_LIS3DH
 
 # imports
 import time
-import math
 from collections import namedtuple
 import struct
-import digitalio
 
 from micropython import const
 
@@ -100,8 +96,10 @@
 # the named tuple returned by the class
 AccelerationTuple = namedtuple("acceleration", ("x", "y", "z"))
 
+
 class LIS2DH12:
     """Driver base for the LIS2DH12 accelerometer."""
+
     def __init__(self):
         # Check device ID.
         device_id = self._read_register_byte(_REG_WHOAMI)
@@ -163,7 +161,8 @@ def acceleration(self):
         elif accel_range == RANGE_2_G:
             divider = 16380
 
-        x, y, z = struct.unpack('<hhh', self._read_register(_REG_OUT_X_L | 0x80, 6))
+        x, y, z = struct.unpack(
+            '<hhh', self._read_register(_REG_OUT_X_L | 0x80, 6))
 
         # convert from Gs to m / s ^ 2 and adjust for the range
         x = (x / divider) * STANDARD_GRAVITY
@@ -172,7 +171,6 @@ def acceleration(self):
 
         return AccelerationTuple(x, y, z)
 
-    
     def _read_register_byte(self, register):
         # Read a byte register value and return it.
         return self._read_register(register, 1)[0]

examples/lis2dh12_simpletest.py

@@ -1,6 +1,5 @@
 import time
 import board
-import digitalio
 import busio
 import electronutlabs_lis2dh12
 
@@ -12,7 +11,8 @@
 while True:
     # Read accelerometer values (in m / s ^ 2).  Returns a 3-tuple of x, y,
     # z axis values.  Divide them by 9.806 to convert to Gs.
-    x, y, z = [value / electronutlabs_lis2dh12.STANDARD_GRAVITY for value in lis2dh12.acceleration]
+    x, y, z = [
+        value / electronutlabs_lis2dh12.STANDARD_GRAVITY for value in lis2dh12.acceleration]
     print("x = %0.3f G, y = %0.3f G, z = %0.3f G" % (x, y, z))
     # Small delay to keep things responsive but give time for interrupt processing.
-    time.sleep(0.5)
+    time.sleep(0.5)

setup.py

@@ -58,7 +58,5 @@
 
     # 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=['electronutlabs_lis2dh12'],
 )