From 4f3ae84c3bbd96cc9409457b00f0e2bc7cecec41 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 10 Apr 2020 13:55:23 -0400 Subject: [PATCH 1/2] PyPI setup and README update. --- README.rst | 48 +++++++++++++++++++++++++++++++++++++++-------- setup.py | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 95 insertions(+), 8 deletions(-) create mode 100644 setup.py diff --git a/README.rst b/README.rst index 511ab3c..cf3f7e4 100644 --- a/README.rst +++ b/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 `_. + +Installing from PyPI +===================== +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. 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 ============ diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..7e405a1 --- /dev/null +++ b/setup.py @@ -0,0 +1,55 @@ +"""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="circuitpython@adafruit.com", + 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"], +) From ebefc3075411736806bbaa16969e38d80e866095 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Fri, 10 Apr 2020 13:57:55 -0400 Subject: [PATCH 2/2] Black reformatting with Python 3 target. --- setup.py | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/setup.py b/setup.py index 7e405a1..b95e951 100644 --- a/setup.py +++ b/setup.py @@ -29,9 +29,7 @@ # Author details author="Adafruit Industries", author_email="circuitpython@adafruit.com", - install_requires=[ - "Adafruit-Blinka", - ], + install_requires=["Adafruit-Blinka",], # Choose your license license="MIT", # See https://pypi.python.org/pypi?%3Aaction=list_classifiers