Merge pull request #11 from kattni/pypi

PyPI setup. Potential Sphinx fix needed.

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,33 @@
-# 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: SukEOXPBiUXVSk6cY/uOEqEpHH7rjKrEOHNpCKcwFVglkjGwKKS6jWer547mrcjq07bHcmBT5Z2YkiBcWo2FxGtIBeZ79PaG1qVjvLhQsvscd1ttEbHBUkya97cQpde+sadPPcp5w6YzwyVJ8Rw6p+d0KeyrJHBkDD+4bxttg/PjSwOTJzUV7DMKVDFju+BKljNezJHyoQj6WXxzzb8N33t5FTFDTtge5qQAn/Ja/YGciJ8IPbw9+7TqgCmx2Mg/jenDZu+iQQBeDWT2wjRA1fl4WPX39hu4DgmCNf6eGy0tk9ilU1oyfRvGLuYc/IvbR/OWzLoj/Ef4EnO0WHIOyU9w5GM2mQPpSmAvamSdvxN0neoPsCaCLcy2tUuFuJeqrGgV1deiIySF8Yd4AiUn8baVvuUOsx9d0t0oeI1ZSX031rqTN8yTIRdiBVWwIlkWY2ULvPezI9VbaLwqlBg3PQpCQJ0kouvNz7knysMk29LLtPT6DnDNmJ2j9/muIzAxn01PW15Qx66RuCwBbI4AG0+P2dS9cXQLL0qL1KjGuHz7hm1PvDG9g+YzkjGiwO1Xg6y2xYoMa5yX5IxJcE1jQqZpBlBZVTtOVGho0xfszT9JFjDH8hXZGQXIENx/C9w7s+jJvinHTV+1B3Y4WgU5v12U+9XYTHGggyNrk0bY37U=
 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_trellism4.py
-  - ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)
-  - circuitpython-build-bundles --filename_prefix adafruit-circuitpython-trellism4 --library_location .
-  - cd docs && sphinx-build -E -W -b html . _build/html
+- pylint adafruit_trellism4.py
+- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace
+  examples/*.py)
+- circuitpython-build-bundles --filename_prefix adafruit-circuitpython-trellism4 --library_location
+  .
+- cd docs && sphinx-build -E -W -b html . _build/html && cd ..

README.rst

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

docs/conf.py

@@ -20,8 +20,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 = ["board", "digitalio", "neopixel", "adafruit_matrixkeypad",
-                        "adafruit_adxl34x", "busio"]
+# autodoc_mock_imports = ["neopixel"]
 
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None),'CircuitPython': ('https://circuitpython.readthedocs.io/en/latest/', None)}

requirements.txt

@@ -1,2 +1,3 @@
 Adafruit-Blinka
-
+adafruit-circuitpython-matrixkeypad
+adafruit-circuitpython-neopixel

setup.py

@@ -0,0 +1,60 @@
+"""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-trellism4',
+
+    use_scm_version=True,
+    setup_requires=['setuptools_scm'],
+
+    description='CircuitPython library Trellis M4 Express.',
+    long_description=long_description,
+    long_description_content_type='text/x-rst',
+
+    # The project's main homepage.
+    url='https://github.com/adafruit/Adafruit_CircuitPython_TrellisM4',
+
+    # Author details
+    author='Adafruit Industries',
+    author_email='[email protected]',
+
+    install_requires=['Adafruit-Blinka'],
+
+    # 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 trellism4 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_trellism4'],
+)