ready for release

Author: siddacious

.gitignore

@@ -9,4 +9,5 @@ bundles
 *.DS_Store
 .eggs
 dist
-**/*.egg-info
+docs/
+**/*.egg-info

.travis.yml

@@ -0,0 +1,37 @@
+dist: xenial
+language: python
+python:
+  - "3.6"
+cache:
+  pip: true
+
+env:
+  - DEPLOY_PYPI="true"
+
+deploy:
+  - provider: releases
+    api_key: "$GITHUB_TOKEN"
+    file_glob: true
+    file: "$TRAVIS_BUILD_DIR/bundles/*"
+    skip_cleanup: true
+    overwrite: true
+    on:
+      tags: true
+  - provider: pypi
+    user: adafruit-travis
+    password:
+      secure: DpEbI64T3Vp2NGlcOC3lRUHfdqenvuUQHdq3nLZTybaGboggsBRWqpnGok/qhY5Ojq0YCrTP/6+tX5LNyJGqo8M2ULPf8Ss4eyafdtKC67kS63y5AxK032P2cipYtAFDhnWmRmd6hxhIVBwcgNE2FOi3QVCz2jIiMq8xvnpeeY87NAjvoW5JcQPzaNHjh+YAleP8xIEdwoXjBRYmx0b9IELCtOTQWQzIcS4dJZ2FPQpQOLTnqh0drROhXDoG7HQQBMliiYir39zSZO9QorJFzHSoccVtT72Kn6ifE05Jh1S5ZGs2Xl4pzNa7+EofemIuR4Umgour00sZv/rFB0fn9LX0ywUD+6PvpDo7MlCBXhsv2CFJHohXCTRdZtjQJhtyn+TiBUScjXyi5xGwX/OORA+5yhiSdcDRhdg28MDluOOEpZdX4TcHoprQk7Pd3wYrTLWY6sSE7xEXezK5mnmALwsz2bnAMtJFMjvngdkZuht+nD5+msL7SW72ETCR7i2dCMGPWYh0hI0/zEFo7YTPCtJ+4EdhqNleq8+JIYXjST0JmxrQMwZgcnKpcUrgH5zh1/+uXPcskEp4q/QYwLJwsLGZ5oMrq1p6FkdQVEQdlDZF5CLlOVZT/wFGPV535yRljhyJEmoC4U3Ix+vOdEkWGGyc2A6u0KTOJaFIHVaXRAQ=
+    on:
+      tags: true
+      condition: $DEPLOY_PYPI = "true"
+
+install:
+  - pip install -r requirements.txt
+  - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
+  - pip install --force-reinstall pylint==1.9.2
+
+script:
+  - pylint adafruit_tlv493d.py
+  - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
+  - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-tlv493d --library_location .
+  - cd docs && sphinx-build -E -W -b html . _build/html && cd ..

README.rst

@@ -30,12 +30,6 @@ This is easily achieved by downloading
 
 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-tlv493d/>`_. To install for current user:
 
@@ -65,14 +59,14 @@ Usage Example
 
     import time
     import board
+    import busio
     import adafruit_tlv493d
 
-    i2c = board.I2C()
-
+    i2c = busio.I2C(board.SCL, board.SDA)
     tlv = adafruit_tlv493d.TLV493D(i2c)
 
     while True:
-        print("%s, %s, %s"%tlv.magnetic)
+        print("X: %s, Y:%s, Z:%s mT"%tlv.magnetic)
         time.sleep(1)
 
 Contributing

adafruit_tlv493d.py

@@ -49,9 +49,11 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_TLV493D.git"
 
-class TLV493D:    
+class TLV493D:
     """Driver for the TLV493D 3-axis Magnetometer.
+
     :param busio.I2C i2c_bus: The I2C bus the TLV493D is connected to.
+
     """
 
     read_masks = {
@@ -85,16 +87,16 @@ class TLV493D:
         "RES3":(3, 0x1F, 0)
     }
 
-    def __init__(self, i2c_interface):
-        self.i2c_device = i2cdevice.I2CDevice(i2c_interface, 0x5E)
+    def __init__(self, i2c_bus):
+        self.i2c_device = i2cdevice.I2CDevice(i2c_bus, 0x5E)
         self.read_buffer = bytearray(10)
         self.write_buffer = bytearray(4)
 
         # read in data from sensor, including data that must be set on a write
         self._setup_write_buffer()
-        
+
         # setup MASTERCONTROLLEDMODE which takes a measurement for every read
-        self._set_write_key('PARITY', 1)   
+        self._set_write_key('PARITY', 1)
         self._set_write_key('PARITY', 1)
         self._set_write_key('LOWPOWER', 1)
         self._set_write_key('LP_PERIOD', 1)
@@ -145,7 +147,7 @@ def magnetic(self):
                 self._unpack_and_scale(y_top, y_bot),
                 self._unpack_and_scale(z_top, z_bot))
 
-    def _unpack_and_scale(self, top, bottom):
-        binval = struct.unpack_from(">h", bytearray([top, bottom]))[0] 
+    def _unpack_and_scale(self, top, bottom): #pylint: disable=no-self-use
+        binval = struct.unpack_from(">h", bytearray([top, bottom]))[0]
         binval = binval >>4
         return binval * 0.098

examples/tlv493d_simpletest.py

@@ -1,11 +1,11 @@
 import time
 import board
+import busio
 import adafruit_tlv493d
 
-i2c = board.I2C()
-
+i2c = busio.I2C(board.SCL, board.SDA)
 tlv = adafruit_tlv493d.TLV493D(i2c)
 
 while True:
-    print("%s, %s, %s"%tlv.magnetic)
-    time.sleep(1)
+    print("X: %s, Y: %s, Z: %s mT"%tlv.magnetic)
+    time.sleep(1)

setup.py

@@ -59,7 +59,6 @@
 
     # 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_tlv493d'],
 )