Merge pull request #17 from kattni/pypi-setup

PyPI setup.

Author: brennen

.travis.yml

@@ -1,33 +1,32 @@
-# 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: trusty
 sudo: false
 language: python
 python:
-    - "3.6"
-
+- '3.6'
 cache:
-    pip: true
-
+  pip: true
 deploy:
-  provider: releases
-  api_key: $GITHUB_TOKEN
+- provider: releases
+  api_key: "$GITHUB_TOKEN"
   file_glob: true
-  file: $TRAVIS_BUILD_DIR/bundles/*
+  file: "$TRAVIS_BUILD_DIR/bundles/*"
   skip_cleanup: true
   overwrite: true
   on:
     tags: true
-
+- provider: pypi
+  user: adafruit-travis
+  on:
+    tags: true
+  password:
+    secure: NjnFwxciOVjDx51McCXiwPbfkMJajWlvLinWlC6XaJOPm/gTp5BbwTe9kJFJpzlV8JXTLoldCa/tC966JMSKle9O9DYyLgKf2PupGvmQxvIjoZBTqRGZqATXrlg9bd37N3hH0giNpbz2JQPZZ41BJ1+B2WqgSLecCot+BuCkqgVJBicjAS8wvtCB+iz2iDq+HwwcHU8QbBCg5yHAxQeEFWLFoZkkjYnY+8InY4JJMR8qgWDhQr32y0tJYqCXb1ys4si9SkUyQLAALKSN871uwAvCHfY4LmT7/Kd8elDayKauTUV0T9LB+nsz6XcZ6mpXV+OG6/RUrPZRpjO3t9QUa5RPlRUDXRWcht2gx0SvBcJ3k79V6snEFphxysMHrcs3Q+tmTiBKHsujb3bvHEAgnGsnztd7rTmb9lqMtbwaDtfg/MtGx7gK/a3j6ZqhwcfqcRvHF7QabaIZgFZDiR97mUrSmS+gQ3lmRSrY141NdwEU0WUHtwUquDcNTVNbKKEFBqvzf4FQg31as/rEEfUyymG8qKbKeyVUUAyfjb16VP7XNCSWg1tti53wRFoA9JkMBtNL5KYUM4wEdXwV5Cm8fEfNC4MSQplq52SbycbzopPnJnaxQfKj3SzKgRAWW9A3VWFKyFfxtIIdefyrkUoBe2+Uj/jwTSr4fe/zBnbsTrE=
 install:
-  - pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme
-  - pip install --force-reinstall pylint==1.9.2
-
+- pip install -r requirements.txt
+- pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme
+- pip install --force-reinstall pylint==1.9.2
 script:
-  - pylint adafruit_featherwing/*.py
-  - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/**/*.py)
-  - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-featherwing --library_location .
-  - cd docs && sphinx-build -E -W -b html . _build/html
+- pylint adafruit_featherwing/*.py
+- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name examples/**/*.py)
+- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-featherwing
+  --library_location .
+- cd docs && sphinx-build -E -W -b html . _build/html && cd ..

README.rst

@@ -30,6 +30,31 @@ This is easily achieved by downloading
 `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_ and highly recommended over
 installing each one.
 
+Installing from PyPI
+--------------------
+
+On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
+PyPI <https://pypi.org/project/adafruit-circuitpython-featherwing/>`_. To install for current user:
+
+.. code-block:: shell
+
+    pip3 install adafruit-circuitpython-featherwing
+
+To install system-wide (this may be required in some cases):
+
+.. code-block:: shell
+
+    sudo pip3 install adafruit-circuitpython-featherwing
+
+To install in a virtual environment in your current project:
+
+.. code-block:: shell
+
+    mkdir project-name && cd project-name
+    python3 -m venv .env
+    source .env/bin/activate
+    pip3 install adafruit-circuitpython-featherwing
+
 Contributing
 ============
 

adafruit_featherwing/joy_featherwing.py

@@ -31,9 +31,9 @@
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing.git"
 
+from micropython import const
 import adafruit_seesaw.seesaw
 from adafruit_featherwing import shared
-from micropython import const
 
 BUTTON_A = const(1 << 6)
 BUTTON_B = const(1 << 7)

adafruit_featherwing/shared.py

@@ -29,7 +29,7 @@
 * Author(s): Scott Shawcroft
 """
 
-from board import SCL, SDA
+import board
 import busio
 
-I2C_BUS = busio.I2C(SCL, SDA)
+I2C_BUS = busio.I2C(board.SCL, board.SDA)

docs/conf.py

@@ -18,8 +18,7 @@
 # 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 = ["adafruit_motor", "adafruit_pca9685", "board", "busio", "adafruit_ina219",
-                        "adafruit_seesaw", "micropython"]
+autodoc_mock_imports = ["board", "busio"]
 
 intersphinx_mapping = {
     'python': ('https://docs.python.org/3.4', None),

requirements.txt

@@ -1,3 +1,7 @@
 Adafruit-Blinka
 adafruit-circuitpython-busdevice
 adafruit-circuitpython-register
+adafruit-circuitpython-motor
+adafruit-circuitpython-pca9685
+adafruit-circuitpython-ina219
+adafruit-circuitpython-seesaw

setup.py

@@ -0,0 +1,65 @@
+"""A setuptools based setup module.
+
+See:
+https://packaging.python.org/en/latest/distributing.html
+https://github.com/pypa/sampleproject
+"""
+
+# Always prefer setuptools over distutils
+from setuptools import setup, find_packages
+# To use a consistent encoding
+from codecs import open
+from os import path
+
+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:
+    long_description = f.read()
+
+setup(
+    name='adafruit-circuitpython-featherwing',
+
+    use_scm_version=True,
+    setup_requires=['setuptools_scm'],
+
+    description='CircuitPython library that provides FeatherWing specific classes for those that '
+                'require a significant amount of initialization.',
+    long_description=long_description,
+    long_description_content_type='text/x-rst',
+
+    # The project's main homepage.
+    url='https://github.com/adafruit/Adafruit_CircuitPython_FeatherWing',
+
+    # Author details
+    author='Adafruit Industries',
+    author_email='[email protected]',
+
+    install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice',
+                      'adafruit-circuitpython-register', 'adafruit-circuitpython-pca9685',
+                      'adafruit-circuitpython-motor', 'adafruit-circuitpython-ina219',
+                      'adafruit-circuitpython-seesaw'],
+
+    # Choose your license
+    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',
+    ],
+
+    # What does your project relate to?
+    keywords='adafruit motor ina219 pca9685 featherwing joy i2c '
+             'hardware micropython circuitpython',
+
+    # You can just specify the packages manually here if your project is
+    # simple. Or you can use find_packages().
+    packages=['adafruit_featherwing'],
+)