Merge pull request #2 from kattni/pypi-setup

Pypi setup

Author: brennen

.gitignore

@@ -1,6 +1,12 @@
+*.mpy
+.idea
 __pycache__
 _build
 *.pyc
 .env
 build*
 bundles
+*.DS_Store
+.eggs
+dist
+**/*.egg-info

.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: xenial
 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: dRYnuD67bSzSZkf7hvM2kl/B/uoK+gue7OQGf2lOlJNnn/cmOqoCKqWKJFMRgy9C37fqdowKdwAJTvtrxKTtqcwaqeWQufG6QsIgaj6JTY+s8Lgj00Wl4kXJw5nez+2IjZ386FUejEH3ydYUOrhKzwA7feIc9QtpyzRiR10EbtP6nXED/ZwBeD4Wa183vjHEIFBMAUZXidBtD3rPEfH3WdrfzwEV0/To4j15xVI1W1QP4GTc8Vvgp1ktqmZdFDXVSlMG5mBMq1g4Fc2KbQDy9a2j4yw3VCwmqiHbdmf1fqrZjjUw8OIZC9muYJyQN1dXKRsQPiwwxWJUWBGZTS8T+N2x1IyL6UTtq2Rr/cRHrcxibFfGhmsycXSMzX5MzMjbqtqyE4hcoVbpqm+TgxYIT36qM4QICkHGbRrR2y9HnU7Qzu1Dw+2yp8yUM141B5MLibynFdpxRYrvfnrhrjMviU9gARFqh5hN7OebucAY46KgTPgADcD6+VTecjES+pCwiyzo6LgLyMSMBVDvrKzw7rifR6nnpERpqpDor3G+HEi2igyNldBDnHOjgqaRMRascI2EtoW5AUQWe/sBJtDuLWsygwmcmQ2D2ymhTwfxDqBhskUOs60yLyk3oUzelEM2/ZtPnM6IeWQCMelVeJb6a6dscYr2EY8uJh/7dDTtgAs=
 install:
-  - pip install -r requirements.txt
-  - pip install circuitpython-build-tools Sphinx sphinx-rtd-theme
-  - pip install --force-reinstall pylint==1.9.2
-
+- 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_motorkit.py
-  - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
-  - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-motorkit --library_location .
-  - cd docs && sphinx-build -E -W -b html . _build/html && cd ..
+- pylint adafruit_motorkit.py
+- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace
+  examples/*.py)
+- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-motorkit --library_location
+  .
+- cd docs && sphinx-build -E -W -b html . _build/html && cd ..

README.rst

@@ -9,8 +9,8 @@ Introduction
     :target: https://discord.gg/nBQh6qu
     :alt: Discord
 
-.. image:: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MotorKit.svg?branch=master
-    :target: https://travis-ci.org/adafruit/Adafruit_CircuitPython_MotorKit
+.. image:: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MotorKit.svg?branch=master
+    :target: https://travis-ci.com/adafruit/Adafruit_CircuitPython_MotorKit
     :alt: Build Status
 
 CircuitPython helper library for the DC & Stepper Motor FeatherWing, Shield and Pi Hat kits.
@@ -29,6 +29,31 @@ 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
+--------------------
+
+On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
+PyPI <https://pypi.org/project/adafruit-circuitpython-motorkit/>`_. To install for current user:
+
+.. code-block:: shell
+
+    pip3 install adafruit-circuitpython-motorkit
+
+To install system-wide (this may be required in some cases):
+
+.. code-block:: shell
+
+    sudo pip3 install adafruit-circuitpython-motorkit
+
+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-motorkit
+
 Usage Example
 =============
 

setup.py

@@ -0,0 +1,64 @@
+"""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-motorkit',
+
+    use_scm_version=True,
+    setup_requires=['setuptools_scm'],
+
+    description='CircuitPython helper library for DC & Stepper Motor FeatherWing, Shield, and '
+                'Pi Hat kits.',
+    long_description=long_description,
+    long_description_content_type='text/x-rst',
+
+    # The project's main homepage.
+    url='https://github.com/adafruit/Adafruit_CircuitPython_MotorKit',
+
+    # Author details
+    author='Adafruit Industries',
+    author_email='circuitpython@adafruit.com',
+
+    install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice',
+                      'adafruit-circuitpython-register', 'adafruit-circuitpython-pca9685',
+                      'adafruit-circuitpython-motor'],
+
+    # 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 pca9685 featherwing pi shield motorkit kit 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_motorkit'],
+)