From a709aacd071260a566b7ebe137c38fac1207400b Mon Sep 17 00:00:00 2001 From: Phil Howard Date: Wed, 14 Mar 2018 14:54:18 +0000 Subject: [PATCH] Prep for v0.1.0 --- library/CHANGELOG.txt | 7 ++ library/MANIFEST.in | 2 +- library/README.rst | 111 ++++++++++++++++++++++++++++++ library/README.txt | 4 -- library/automationhat/__init__.py | 2 +- library/setup.py | 6 +- packaging/CHANGELOG | 8 +++ packaging/debian/changelog | 8 +++ 8 files changed, 139 insertions(+), 9 deletions(-) create mode 100644 library/README.rst delete mode 100644 library/README.txt diff --git a/library/CHANGELOG.txt b/library/CHANGELOG.txt index 3be5753..4774a95 100644 --- a/library/CHANGELOG.txt +++ b/library/CHANGELOG.txt @@ -1,3 +1,10 @@ +0.1.0 +----- + +* Fix: Defer setup to avoid import side effects +* Fix: Slowed LED update rate +* Improvement: Switched to warnings to notify about unsupported features on pHAT + 0.0.4 ----- diff --git a/library/MANIFEST.in b/library/MANIFEST.in index 74df6f6..71df505 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 automationhat/*.py diff --git a/library/README.rst b/library/README.rst new file mode 100644 index 0000000..ef704a3 --- /dev/null +++ b/library/README.rst @@ -0,0 +1,111 @@ +Automation HAT +============== + +.. image:: https://raw.githubusercontent.com/pimoroni/automation-hat/master/autohat_360.png + :alt: Automation HAT + +* https://shop.pimoroni.com/products/automation-hat +* https://shop.pimoroni.com/products/automation-phat + +Automation HAT/pHAT is a home monitoring and automation controller +featuring relays, analog channels, powered outputs, and buffered inputs +(all 24V tolerant). + +Installing +---------- + +Full install (recommended): +~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +We've created an easy installation script that will install all +pre-requisites and get your Automation HAT/pHAT 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: + +.. image:: 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/automationhat | 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/automationhat/``. + +Manual install: +~~~~~~~~~~~~~~~ + +Library install for Python 3: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +on Raspbian: + +.. code:: bash + + sudo apt-get install python3-automationhat + +other environments: + +.. code:: bash + + sudo pip3 install automationhat + +Library install for Python 2: +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +on Raspbian: + +.. code:: bash + + sudo apt-get install python-automationhat + +other environments: + +.. code:: bash + + sudo pip2 install automationhat + +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) + +In all cases you will have to enable the i2c bus. + +Documentation & Support +----------------------- + +- Guides and tutorials + * https://learn.pimoroni.com/automation-hat + * https://learn.pimoroni.com/automation-phat +- Function reference + * https://github.com/pimoroni/automation-hat/tree/master/documentation +- GPIO Pinout + * https://pinout.xyz/pinout/automation\_hat + * https://pinout.xyz/pinout/automation\_phat +- Get help + * http://forums.pimoroni.com/c/support + diff --git a/library/README.txt b/library/README.txt deleted file mode 100644 index 9c68e0c..0000000 --- a/library/README.txt +++ /dev/null @@ -1,4 +0,0 @@ -Automation HAT --------------- - - diff --git a/library/automationhat/__init__.py b/library/automationhat/__init__.py index 0c03d53..427cc22 100644 --- a/library/automationhat/__init__.py +++ b/library/automationhat/__init__.py @@ -11,7 +11,7 @@ from .ads1015 import ads1015 from .pins import ObjectCollection, AsyncWorker, StoppableThread -__version__ = '0.0.4' +__version__ = '0.1.0' RELAY_1 = 13 diff --git a/library/setup.py b/library/setup.py index 14fbb12..e3d72e8 100644 --- a/library/setup.py +++ b/library/setup.py @@ -70,13 +70,13 @@ def run(self): setup( name = 'automationhat', - version = '0.0.4', + version = '0.1.0', author = 'Philip Howard', author_email = 'phil@pimoroni.com', description = 'Automation HAT Driver', - 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 automation controller', + keywords = ['Raspberry Pi', 'automation controller'], url = 'http://www.pimoroni.com', classifiers = classifiers, py_modules = [], diff --git a/packaging/CHANGELOG b/packaging/CHANGELOG index 0af4037..49d702d 100644 --- a/packaging/CHANGELOG +++ b/packaging/CHANGELOG @@ -1,3 +1,11 @@ +automationhat (0.1.0) stable; urgency=low + + * Fix: Defer setup to avoid import side effects + * Fix: Slowed LED update rate + * Improvement: Switched to warnings to notify about unsupported features on pHAT + + -- Phil Howard Wed, 14 Mar 2018 12:00:00 +0000 + automationhat (0.0.4) stable; urgency=low * Fix for HAT/pHAT detection diff --git a/packaging/debian/changelog b/packaging/debian/changelog index 0af4037..49d702d 100644 --- a/packaging/debian/changelog +++ b/packaging/debian/changelog @@ -1,3 +1,11 @@ +automationhat (0.1.0) stable; urgency=low + + * Fix: Defer setup to avoid import side effects + * Fix: Slowed LED update rate + * Improvement: Switched to warnings to notify about unsupported features on pHAT + + -- Phil Howard Wed, 14 Mar 2018 12:00:00 +0000 + automationhat (0.0.4) stable; urgency=low * Fix for HAT/pHAT detection