updated build and doc config files

fourstix · fourstix · commit e197ba5b3cd3 · 2019-07-09T09:11:29.000-04:00
diff --git a/.travis.yml b/.travis.yml
@@ -11,11 +11,8 @@ 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"
+  - DEPLOY_PYPI="true"
 
 deploy:
   - provider: releases
@@ -29,9 +26,9 @@ deploy:
   # 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
+    user: fourstix
     password:
-      secure: #-- PASTE ENCRYPTED PASSWORD HERE --#
+      secure: uYIy80a9qoGtRUQsczO8b7HRwhd2PELYjBpHuFGCgbj9nMsPyiwgHwREZhF7sr1Mbw3uI2DQaqqVvhax/9inncO9pX1228Iaw8bfgxVrnhhiRr4ruUleGr9z7Fp1TxLFfo2/bZVSq0NJ2abZ7JuCAkB9KxL50eeoo5vtVk8ZUlsi1DOxdiU9VgrGZ3cVemiBH49RZzZ/n3sTAkWmFIzzpc2daTU0yX9UOBTNwXUf8aL+g+jOgAGN8XLbRwgd/HU09evnaQh93U1cxb+3QC9TbM3tLTEWCmB/YN1AtGYj1z8+PvBKtbuzcH0TktBZ2yFiOXbD7ikeq7nJApD2uLc/t7Y4UTSjOvoeqy/YTbCEgQxo75hVFuZe5PIQH4/hFGULY/7FTW0T36qdVtLkwNSUP7ZYSX6rZFVo9FdZSPaKB5g4Ve+gQRJzOepK8faTyGfUgl7LlQqI7xPogNlXYsn9RxzRr2ZU5vC9qKu8Pk7/mBGF9pvPKx1CE3lYi41CePDxRFMDrbdtLEHyfQ2K+qt7Nlk4mzyqFgo8kb+LFfRzSRbDdEmHC9htaEA1cAk/UJJhNMNRZKYYuVfJHBbaQhnT7ponK1Gjmrhen9d+fZ7ojyHG5baKdYMtAtfTYsgU3O/7GzaEBPYjBow69ESlKFWUBh4Ik8KJNNa8Qmd0VhMzPIc=
     on:
       tags: true
       condition: $DEPLOY_PYPI = "true"
diff --git a/docs/conf.py b/docs/conf.py
@@ -16,11 +16,7 @@
     '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 = ["digitalio", "busio"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}
diff --git a/docs/examples.rst b/docs/examples.rst
@@ -6,3 +6,45 @@ Ensure your device works with this simple test.
 .. literalinclude:: ../examples/qwiicas3935_simpletest.py
     :caption: examples/qwiicas3935_simpletest.py
     :linenos:
+
+Examples (I2C)
+---------
+
+1. Basic Lightning (I2C) - Show lightning events.
+
+.. literalinclude:: ../examples/example1_basic_lightning_i2c.py
+    :caption: examples/example1_basic_lightning_i2c.py
+    :linenos:
+
+2. More Lightning Features (I2C) - Functions that prevent noise and false events.
+
+.. literalinclude:: ../examples/example2_more_lightning_features_i2c.py
+    :caption: examples/example2_more_lightning_features_i2c.py
+    :linenos:
+
+3. Tune Antenna (I2C) - Tune the resonance frequency of the antenna.
+
+.. literalinclude:: ../examples/example3_tune_antenna_i2c.py
+    :caption: examples/example3_tune_antenna_i2c.py
+    :linenos:
+
+Examples (SPI)
+---------
+
+1. Basic Lightning (SPI) - Show lightning events.
+
+.. literalinclude:: ../examples/example1_basic_lightning_spi.py
+    :caption: examples/example1_basic_lightning_spi.py
+    :linenos:
+
+2. More Lightning Features (SPI) - Functions that prevent noise and false events.
+
+.. literalinclude:: ../examples/example2_more_lightning_features_spi.py
+    :caption: examples/example2_more_lightning_features_spi.py
+    :linenos:
+
+3. Tune Antenna (SPI) - Tune the resonance frequency of the antenna.
+
+.. literalinclude:: ../examples/example3_tune_antenna_spi.py
+    :caption: examples/example3_tune_antenna_spi.py
+    :linenos:
diff --git a/docs/index.rst b/docs/index.rst
@@ -23,14 +23,12 @@ 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.
+    Sparkfun Qwiic Lightning Detector Hookup Guide <https://learn.sparkfun.com/tutorials/sparkfun-qwiic-as3935-lightning-detector-hookup-guide> 
 
 .. 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.
+    Sparkfun Qwiic Lightning Detector <https://www.sparkfun.com/products/15276>
 
 .. toctree::
     :caption: Other Links
diff --git a/requirements.txt b/requirements.txt
@@ -1 +1,2 @@
 Adafruit-Blinka
+adafruit-circuitpython-busdevice
diff --git a/setup.py b/setup.py
@@ -17,7 +17,7 @@
     long_description = f.read()
 
 setup(
-    name='adafruit-circuitpython-qwiicas3935',
+    name='sparkfun-circuitpython-qwiicas3935',
 
     use_scm_version=True,
     setup_requires=['setuptools_scm'],
@@ -27,14 +27,15 @@
     long_description_content_type='text/x-rst',
 
     # The project's main homepage.
-    url='https://github.com/adafruit/Adafruit_CircuitPython_QwiicAS3935',
+    url='https://github.com/fourstix/Sparkfun_CircuitPython_QwiicAS3935',
 
     # Author details
-    author='Adafruit Industries',
-    author_email='circuitpython@adafruit.com',
+    author='Gaston Williams',
+    author_email='fourstix@gmail.com',
 
     install_requires=[
-        'Adafruit-Blinka'
+        'Adafruit-Blinka',
+        'adafruit-circuitpython-busdevice'
     ],
 
     # Choose your license
diff --git a/sparkfun_qwiicas3935.py b/sparkfun_qwiicas3935.py
@@ -30,7 +30,7 @@
 
 * Based on the Arduino library for the Qwiic AS3935 Lightning Detector
 * Written by Elias Santistevan @ SparkFun Electronics in January, 2019
-* Register read function based on code written by Phil Fenstermacher
+* I2C Register read functions based on code written by Phil Fenstermacher
 * on December, 2014 as part of the RPi_AS3935 python library.
 
 Implementation Notes
@@ -543,7 +543,7 @@ def _read_register(self, register):
 
     def _read_byte(self, register):
         # Read all the registers and get byte values above 0x08.  This range
-        # contains the lightning look-up tables and calibration regisers.
+        # contains the lightning look-up tables and calibration registers.
         # The read_register is more efficent for more frequent data registers.
         with self._i2c as i2c:
             i2c.write(bytes([0x00]),stop=False)
diff --git a/travis.txt b/travis.txt
@@ -0,0 +1,48 @@
+# This is a common .travis.yml for generating library release zip files for
+# CircuitPython library releases using circuitpython-build-tools.
+# See https://github.com/adafruit/circuitpython-build-tools for detailed setup
+# instructions.
+
+dist: xenial
+language: python
+python:
+  - "3.6"
+
+cache:
+  pip: true
+
+#       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="true"
+
+deploy:
+  - provider: releases
+    api_key: "$GITHUB_TOKEN"
+    file_glob: true
+    file: "$TRAVIS_BUILD_DIR/bundles/*"
+    skip_cleanup: true
+    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: fourstix
+    password:
+      secure: MgHwILmPMRF+gn/Xo+9jbTLFD/GIrkdR8TPrxxUU8iAlCjoqoRWV5WDe4Q9itLyP2qkSvSg+24l30NC9IqYzUH8OzSy9dIMUzv3mUJOryr1cnhT7QhR+8PJafegEPiYtP1g9Laq3b6du6tYjBhOY2yA0uZmp3OY0vhL18ZbWOYwKzEf6GXiruhTY2BrC+4O8SjFaQJC/qBQCQ1LoyM947q2DFGhamYVfxwExLWsEcUHA8eNXYWDz9PTi/l+0qmN89uDDFpZMWTXRnnuhlJ6bbirG+Dz+Z8crBKNh/GT840OzqF5zyEUR7QQz2Eg932dulRuPiJgT6TXpgplwlzHl+sa6kke3LuCUoZB5GXHG4DwR84SQlSGvAEAzN6lMzRzduqJal202xlOVS529ASV+72OtLtMNAAOHEhbg/pAiY0rYZFK7yHDQnJRrIzaaMs7EzYA+ZqrclIuGrY2PENM59uGybm4BX2BCI9FTGWIatfC70RdnCzDrTF6EE12ikwcYPZfErYFXabqQhcWMDGYnJw86HYi5K5xGmGfwnfxwoa4vGBW1gtx6uOHU57VmN2gXUICWgtrmLsx3jhIIVAYIY5J+eCI4c3rJh2OwyEGE1VR4RCSXJ5XBJXoKzcvvjYsOxq7upywcL9zOHlyf8e2WGJ3BoreVPFdPRV3eFWSgD0U=
+    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 sparkfun_qwiictwist.py
+  - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
+  - circuitpython-build-bundles --filename_prefix sparkfun-circuitpython-qwiictwist --library_location .
+  - cd docs && sphinx-build -E -W -b html . _build/html && cd ..

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`	`1`	`Adafruit-Blinka`
	`2`	`+adafruit-circuitpython-busdevice`