From 142e3c16cf6092010dd1f929cef892a599a49c20 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 23 Mar 2019 09:43:13 -0500 Subject: [PATCH 1/4] add Blinka to 'setup.py->install_requires'; add PyPI install to README --- README.rst | 27 ++++++++++++++++++++++++++- setup.py | 2 +- 2 files changed, 27 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index c6c8a03..377ffc4 100644 --- a/README.rst +++ b/README.rst @@ -28,6 +28,31 @@ 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 +-------------------- + 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-pca9685 + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-pca9685 + +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-pca9685 + Usage Example ============= @@ -85,4 +110,4 @@ Now, once you have the virtual environment activated: This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to -locally verify it will pass. \ No newline at end of file +locally verify it will pass. diff --git a/setup.py b/setup.py index 050578f..12942f7 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,7 @@ author='Radomir Dopieralski & Adafruit Industries', author_email='circuitpython@adafruit.com', - install_requires=['adafruit-circuitpython-busdevice', 'adafruit-circuitpython-register'], + install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice', 'adafruit-circuitpython-register'], # Choose your license license='MIT', From 1eba252633e2763d8e30870e9e230ee90f8388b0 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 23 Mar 2019 09:44:55 -0500 Subject: [PATCH 2/4] renamed example files to match naming convention --- examples/{calibration.py => pca9685_calibration.py} | 0 examples/{servo.py => pca9685_servo.py} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename examples/{calibration.py => pca9685_calibration.py} (100%) rename examples/{servo.py => pca9685_servo.py} (100%) diff --git a/examples/calibration.py b/examples/pca9685_calibration.py similarity index 100% rename from examples/calibration.py rename to examples/pca9685_calibration.py diff --git a/examples/servo.py b/examples/pca9685_servo.py similarity index 100% rename from examples/servo.py rename to examples/pca9685_servo.py From 1327dcb01df749f329849c9ecdfd5f98d42d5008 Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 23 Mar 2019 09:49:09 -0500 Subject: [PATCH 3/4] update 'docs/examples.rst' with new filenames --- docs/examples.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/examples.rst b/docs/examples.rst index 2fec63d..7623aae 100644 --- a/docs/examples.rst +++ b/docs/examples.rst @@ -7,10 +7,10 @@ Ensure your device works with this simple test. :caption: examples/pca9685_simpletest.py :linenos: -.. literalinclude:: ../examples/calibration.py - :caption: examples/calibration.py +.. literalinclude:: ../examples/pca9685_calibration.py + :caption: examples/pca9685_calibration.py :linenos: -.. literalinclude:: ../examples/servo.py - :caption: examples/servo.py - :linenos: \ No newline at end of file +.. literalinclude:: ../examples/pca9685_servo.py + :caption: examples/pca9685_servo.py + :linenos: From 9ed981de4baa24e375a09fd9e54d486f3b1297dc Mon Sep 17 00:00:00 2001 From: sommersoft Date: Sat, 23 Mar 2019 09:56:14 -0500 Subject: [PATCH 4/4] paste fail --- README.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/README.rst b/README.rst index 377ffc4..5d58b31 100644 --- a/README.rst +++ b/README.rst @@ -30,7 +30,6 @@ This is easily achieved by downloading Installing from PyPI -------------------- - 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: