Merge pull request #18 from kattni/pypi-setup

PyPI setup and README update.

Author: dhalbert

README.rst

@@ -25,20 +25,52 @@ 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-led animation/>`_. To install for current user:
+
+.. code-block:: shell
+
+    pip3 install adafruit-circuitpython-led animation
+
+To install system-wide (this may be required in some cases):
+
+.. code-block:: shell
+
+    sudo pip3 install adafruit-circuitpython-led animation
+
+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-led animation
+
 Usage Example
 =============
 
 .. code-block:: python
 
-    import adafruit_dotstar as dotstar
     import board
-    from led_animation import color
-    # setup the pixel
-    dot = dotstar.DotStar(board.APA102_SCK, board.APA102_MOSI, 1, brightness=.2)
-    # set the color by name
-    dot[0] = color.GOLD
-    # show the pixel
-    dot.show()
+    import neopixel
+    from adafruit_led_animation.animation import Blink
+    import adafruit_led_animation.color as color
+
+    # Works on Circuit Playground Express and Bluefruit.
+    # For other boards, change board.NEOPIXEL to match the pin to which the NeoPixels are attached.
+    pixel_pin = board.NEOPIXEL
+    # Change to match the number of pixels you have attached to your board.
+    num_pixels = 10
+
+    pixels = neopixel.NeoPixel(pixel_pin, num_pixels)
+    blink = Blink(pixels, 0.5, color.PURPLE)
+
+    while True:
+        blink.animate()
 
 Contributing
 ============

setup.py

@@ -0,0 +1,53 @@
+"""A setuptools based setup module.
+
+See:
+https://packaging.python.org/en/latest/distributing.html
+https://github.com/pypa/sampleproject
+"""
+
+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-led animation",
+    use_scm_version=True,
+    setup_requires=["setuptools_scm"],
+    description="CircuitPython helper for LED colors and animations.",
+    long_description=long_description,
+    long_description_content_type="text/x-rst",
+    # The project's main homepage.
+    url="https://github.com/adafruit/Adafruit_CircuitPython_LED Animation",
+    # 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 blinka circuitpython micropython led animation led colors animations",
+    # You can just specify the packages manually here if your project is
+    # simple. Or you can use find_packages().
+    # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
+    #       CHANGE `py_modules=['...']` TO `packages=['...']`
+    py_modules=["adafruit_led animation"],
+)