From 097f255c38792dabe0cb98dc5ca9954112f335ed Mon Sep 17 00:00:00 2001 From: Pierrick C Date: Sun, 16 Jun 2019 17:33:35 +0200 Subject: [PATCH] Update README.rst, requirement.txt,... --- README.rst | 43 +++---------------- circuitpython_neotrellism4.py | 5 ++- .../neotrellism4_multitrellis_simpletest.py | 2 +- examples/neotrellism4_simpletest.py | 3 +- requirements.txt | 2 + 5 files changed, 12 insertions(+), 43 deletions(-) diff --git a/README.rst b/README.rst index d6d7dac..388d668 100644 --- a/README.rst +++ b/README.rst @@ -22,70 +22,37 @@ This driver depends on: * `Adafruit CircuitPython `_ * `Bus Device `_ -* `Adafruit Seesaw helper ` -* `Adafruit MatrixKeypad ` -* `Neopixel ` +* `Adafruit Seesaw helper `_ +* `Adafruit MatrixKeypad `_ +* `Neopixel `_ 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 --------------------- -.. note:: This library is not available on PyPI yet. Install documentation is included - as a standard element. Stay tuned for PyPI availability! -.. todo:: Remove the above note if PyPI version is/will be available at time of release. - If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section. -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-neotrellism4 - -To install system-wide (this may be required in some cases): - -.. code-block:: shell - - sudo pip3 install adafruit-circuitpython-neotrellism4 - -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-neotrellism4 - Usage Example ============= To use Trellis as 2 Neotrellis (seesaw): -.. code-block:: python3 +.. code-block:: python from neotrellism4 import NeoTrellisM4 - - #create the trellis trellis_left = NeoTrellisM4() trellis_right = NeoTrellisM4(left_part=trellis_left) To use TrellisM4 tilled with Neotrellis (seesaw): -.. code-block:: python3 +.. code-block:: python from board import SCL, SDA import busio from adafruit_neotrellis.neotrellism4 import NeoTrellisM4 from adafruit_neotrellis.neotrellis import NeoTrellis from adafruit_neotrellis.multitrellis import MultiTrellis - I2C = busio.I2C(SCL, SDA) - trellim4_left = NeoTrellisM4() trellim4_right = NeoTrellisM4(left_part=trellim4_left) trelli = [ [trellim4_left, trellim4_right], [NeoTrellis(I2C, False, addr=0x2F), NeoTrellis(I2C, False, addr=0x2E)] ] - trellis = MultiTrellis(trelli) Contributing diff --git a/circuitpython_neotrellism4.py b/circuitpython_neotrellism4.py index 1e351ed..2351487 100644 --- a/circuitpython_neotrellism4.py +++ b/circuitpython_neotrellism4.py @@ -23,7 +23,8 @@ `circuitpython_neotrellism4` ================================================================================ -Use Adafruit TrellisM4 Express board as 2 Neotrellis board. You can you use this to extend TrellisM4 with Neotrellis (seesaw) boards. +Use Adafruit TrellisM4 Express board as 2 Neotrellis seesaw boards. +You can you use this to extend TrellisM4 with Neotrellis (seesaw) boards. * Author(s): arofarn @@ -111,7 +112,7 @@ class _TrellisNeoPixel: self.auto_write = current_auto_write def show(self): - """fill method wrapper + """Fill method wrapper """ self.pix.show() diff --git a/examples/neotrellism4_multitrellis_simpletest.py b/examples/neotrellism4_multitrellis_simpletest.py index e29a7c2..225754f 100644 --- a/examples/neotrellism4_multitrellis_simpletest.py +++ b/examples/neotrellism4_multitrellis_simpletest.py @@ -2,9 +2,9 @@ import time from board import SCL, SDA import busio -from adafruit_neotrellis.neotrellism4 import NeoTrellisM4 from adafruit_neotrellis.neotrellis import NeoTrellis from adafruit_neotrellis.multitrellis import MultiTrellis +from neotrellism4 import NeoTrellisM4 #create the i2c object for the trellis I2C = busio.I2C(SCL, SDA) diff --git a/examples/neotrellism4_simpletest.py b/examples/neotrellism4_simpletest.py index 7716dea..652fa66 100644 --- a/examples/neotrellism4_simpletest.py +++ b/examples/neotrellism4_simpletest.py @@ -1,7 +1,6 @@ import time -from adafruit_neotrellis.neotrellism4 import NeoTrellisM4 - +from neotrellism4 import NeoTrellisM4 #create the trellis trellis_left = NeoTrellisM4() diff --git a/requirements.txt b/requirements.txt index 0f7aaed..b978884 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,5 @@ Adafruit-Blinka adafruit-circuitpython-busdevice neopixel +adafruit_seesaw +adafruit_matrixkeypad