Skip to content

Pypi fix #21

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 26, 2019
Merged

Pypi fix #21

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
142e3c1
add Blinka to 'setup.py->install_requires'; add PyPI install to README
sommersoft Mar 23, 2019
1eba252
renamed example files to match naming convention
sommersoft Mar 23, 2019
1327dcb
update 'docs/examples.rst' with new filenames
sommersoft Mar 23, 2019
9ed981d
paste fail
sommersoft Mar 23, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 25 additions & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,30 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.

Installing from PyPI
--------------------
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-pca9685/>`_. 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
=============

Expand Down Expand Up @@ -85,4 +109,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.
locally verify it will pass.
10 changes: 5 additions & 5 deletions docs/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
.. literalinclude:: ../examples/pca9685_servo.py
:caption: examples/pca9685_servo.py
:linenos:
0 examples/calibration.py → examples/pca9685_calibration.py
View file
Open in desktop
File renamed without changes.
0 examples/servo.py → examples/pca9685_servo.py
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
author='Radomir Dopieralski & Adafruit Industries',
author_email='[email protected]',

install_requires=['adafruit-circuitpython-busdevice', 'adafruit-circuitpython-register'],
install_requires=['Adafruit-Blinka', 'adafruit-circuitpython-busdevice', 'adafruit-circuitpython-register'],

# Choose your license
license='MIT',
Expand Down