Merge pull request #3 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,34 +1,31 @@
-# 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: lDPtYKxyqrKUk/kT770l/yw1TdvNhaIFjCZcEvagzg+RdDTcosDjzp2UGmLI81cOKMmPhJgGVLDN80srHcGdgJThfgqxcDwIBDx+Ggtwf16FFjsjOa3PAhGdo9zOFhj4hhYiF8an6jNVJQlGUbCcMBOW3DbNgze5fScwDQaWBqSJyj7YvtNZukMT6YGCqWRF+UO4VmCBp/tpZc09oA8zHwZG8IKkLhMjKugD8ezx1qL4jXsJ+MMPSoPjweAWpPOqfzVImD1ykTvgLLNJohOvPXs9YfDcMlq0fScpHH1q0VQngFM+u0Y6eQbA01pJGtDjBxrxvWNKwpoUwALscdPlnHOduWAIW5vGlGx3X/Q/N+ntOWjVotsNPQ2ag0RP25UOvvL5m29JuHXTgWz+CtJpik+uZoT5zn8bNZwL5i0waIKLqERRj8sEdd6BbamqWnUFSQg9mZ9niEvRiTk62yv1vfhZmrJlz7ZGSVBqczGFbfpkmC6LVORAr8nps08HGhsYrfJIUQ+kyAfka6VzMEAsphu2JrFwJEbzsuPWD2Y2esen8vUn/rK0Vfi4Tzp7DLrTKETC5u2B2ZHyC0k40twxg5bmoKjXo1eBgdiNCdNFJXiPRCnPLgMau5Q6z1QJXiuOkdpWxuJDaNwYH2+ZuYZuei8Q/lBwXZQgV8l5yR4xDxA=
 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 pylint circuitpython-build-tools Sphinx sphinx-rtd-theme
+- pip install --force-reinstall pylint==1.9.2
 script:
-  - pylint adafruit_us100.py
-  - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
-  - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-us100 --library_location .
-  - cd docs && sphinx-build -E -W -b html . _build/html
+- pylint adafruit_us100.py
+- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
+- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-us100 --library_location .
+- cd docs && sphinx-build -E -W -b html . _build/html && cd ..

README.rst

@@ -26,6 +26,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-us100/>`_. To install for current user:
+
+.. code-block:: shell
+
+    pip3 install adafruit-circuitpython-us100
+
+To install system-wide (this may be required in some cases):
+
+.. code-block:: shell
+
+    sudo pip3 install adafruit-circuitpython-us100
+
+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-us100
+
 Usage Example
 =============
 

setup.py

@@ -0,0 +1,62 @@
+"""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-us100',
+
+    use_scm_version=True,
+    setup_requires=['setuptools_scm'],
+
+    description='CircuitPython library for reading distance and temperature via US-100 '
+                'ultra-sonic sensor.',
+    long_description=long_description,
+    long_description_content_type='text/x-rst',
+
+    # The project's main homepage.
+    url='https://github.com/adafruit/Adafruit_CircuitPython_US100',
+
+    # Author details
+    author='Adafruit Industries',
+    author_email='[email protected]',
+
+    install_requires=['Adafruit-Blinka', 'pyserial'],
+
+    # 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 us100 temperature temp distance sensor ultra-sonic'
+             ' hardware micropython circuitpython',
+
+    # You can just specify the packages manually here if your project is
+    # simple. Or you can use find_packages().
+    py_modules=['adafruit_us100'],
+)