From 7e3379e30e9273d41229fd3e7723218fab915ecb Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Wed, 23 May 2018 12:01:24 +0100 Subject: [PATCH] Prep for v0.1.2 --- library/CHANGELOG.txt | 5 ++ library/MANIFEST.in | 2 +- library/README.rst | 104 +++++++++++++++++++++++++++++++++++++ library/README.txt | 3 -- library/blinkt.py | 2 +- library/setup.py | 4 +- packaging/CHANGELOG | 6 +++ packaging/debian/changelog | 6 +++ 8 files changed, 125 insertions(+), 7 deletions(-) create mode 100644 library/README.rst delete mode 100644 library/README.txt diff --git a/library/CHANGELOG.txt b/library/CHANGELOG.txt index fa31202..3e5edb2 100644 --- a/library/CHANGELOG.txt +++ b/library/CHANGELOG.txt @@ -1,3 +1,8 @@ +0.1.2 +----- + +* BugFix: Added sleep to data output, see: https://github.com/pimoroni/blinkt/issues/62 + 0.1.1 ----- diff --git a/library/MANIFEST.in b/library/MANIFEST.in index b8fd881..090a8ba 100644 --- a/library/MANIFEST.in +++ b/library/MANIFEST.in @@ -1,5 +1,5 @@ include CHANGELOG.txt include LICENSE.txt -include README.txt +include README.rst include setup.py include blinkt.py diff --git a/library/README.rst b/library/README.rst new file mode 100644 index 0000000..785b69a --- /dev/null +++ b/library/README.rst @@ -0,0 +1,104 @@ +|Blinkt!| https://shop.pimoroni.com/products/blinkt + +Eight super-bright RGB LED indicators, ideal for adding visual +notifications to your Raspberry Pi on their own or on a pHAT stacking +header. + +Installing +---------- + +Full install (recommended): +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We've created an easy installation script that will install all +pre-requisites and get your Blinkt! up and running with minimal efforts. +To run it, fire up Terminal which you'll find in Menu -> Accessories -> +Terminal on your Raspberry Pi desktop, as illustrated below: + +.. figure:: http://get.pimoroni.com/resources/github-repo-terminal.png + :alt: Finding the terminal + +In the new terminal window type the command exactly as it appears below +(check for typos) and follow the on-screen instructions: + +.. code:: bash + + curl https://get.pimoroni.com/blinkt | bash + +Alternatively, on Raspbian, you can download the ``pimoroni-dashboard`` +and install your product by browsing to the relevant entry: + +.. code:: bash + + sudo apt-get install pimoroni + +(you will find the Dashboard under 'Accessories' too, in the Pi menu - +or just run ``pimoroni-dashboard`` at the command line) + +If you choose to download examples you'll find them in +``/home/pi/Pimoroni/blinkt/``. + +Manual install: +~~~~~~~~~~~~~~~ + +Library install for Python 3: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +on Raspbian: + +.. code:: bash + + sudo apt-get install python3-blinkt + +other environments: + +.. code:: bash + + sudo pip3 install blinkt + +Library install for Python 2: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +on Raspbian: + +.. code:: bash + + sudo apt-get install python-blinkt + +other environments: + +.. code:: bash + + sudo pip2 install blinkt + +Development: +~~~~~~~~~~~~ + +If you want to contribute, or like living on the edge of your seat by +having the latest code, you should clone this repository, ``cd`` to the +library directory, and run: + +.. code:: bash + + sudo python3 setup.py install + +(or ``sudo python setup.py install`` whichever your primary Python +environment may be) + +Documentation & Support +----------------------- + +- Guides and tutorials - https://learn.pimoroni.com/blinkt +- Function reference - http://docs.pimoroni.com/blinkt/ +- GPIO Pinout - https://pinout.xyz/pinout/blinkt +- Get help - http://forums.pimoroni.com/c/support + +Unofficial / Third-party libraries +---------------------------------- + +- Golang library & examples by `Alex + Ellis `__ - + https://github.com/alexellis/blinkt\_go\_examples +- Java library by Jim Darby - https://github.com/hackerjimbo/PiJava + +.. |Blinkt!| image:: https://raw.githubusercontent.com/pimoroni/blinkt/master/blinkt-logo.png diff --git a/library/README.txt b/library/README.txt deleted file mode 100644 index d74d24d..0000000 --- a/library/README.txt +++ /dev/null @@ -1,3 +0,0 @@ - -Learn more: https://shop.pimoroni.com/products/blinkt - diff --git a/library/blinkt.py b/library/blinkt.py index 3721eb9..3dae994 100644 --- a/library/blinkt.py +++ b/library/blinkt.py @@ -4,7 +4,7 @@ import RPi.GPIO as GPIO -__version__ = '0.1.1' +__version__ = '0.1.2' DAT = 23 CLK = 24 diff --git a/library/setup.py b/library/setup.py index cf8aa36..de68537 100755 --- a/library/setup.py +++ b/library/setup.py @@ -39,11 +39,11 @@ setup( name = 'blinkt', - version = '0.1.1', + version = '0.1.2', author = 'Philip Howard', author_email = 'phil@pimoroni.com', description = """Python library for driving Pimoroni Blinkt!""", - long_description= open('README.txt').read() + open('CHANGELOG.txt').read(), + long_description= open('README.rst').read() + "\n" + open('CHANGELOG.txt').read(), license = 'MIT', keywords = 'Raspberry Pi LED', url = 'http://www.pimoroni.com', diff --git a/packaging/CHANGELOG b/packaging/CHANGELOG index 2c2c537..0cd6a8f 100644 --- a/packaging/CHANGELOG +++ b/packaging/CHANGELOG @@ -1,3 +1,9 @@ +blinkt (0.1.2) STABLE; urgency=low + + * BugFix: Added sleep to data output, see: https://github.com/pimoroni/blinkt/issues/62 + + -- Phil Howard Wed, 23 May 2018 00:00:00 +0000 + blinkt (0.1.1) STABLE; urgency=low * New: Added `get_pixel` to return colour and brightness of a single pixel diff --git a/packaging/debian/changelog b/packaging/debian/changelog index 2c2c537..0cd6a8f 100644 --- a/packaging/debian/changelog +++ b/packaging/debian/changelog @@ -1,3 +1,9 @@ +blinkt (0.1.2) STABLE; urgency=low + + * BugFix: Added sleep to data output, see: https://github.com/pimoroni/blinkt/issues/62 + + -- Phil Howard Wed, 23 May 2018 00:00:00 +0000 + blinkt (0.1.1) STABLE; urgency=low * New: Added `get_pixel` to return colour and brightness of a single pixel