Skip to content

Commit 142e3c1

Browse files
committed
add Blinka to 'setup.py->install_requires'; add PyPI install to README
1 parent aa4ebe0 commit 142e3c1

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

README.rst

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,31 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2828
This is easily achieved by downloading
2929
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3030

31+
Installing from PyPI
32+
--------------------
33+
If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
34+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
35+
PyPI <https://pypi.org/project/adafruit-circuitpython-pca9685/>`_. To install for current user:
36+
37+
.. code-block:: shell
38+
39+
pip3 install adafruit-circuitpython-pca9685
40+
41+
To install system-wide (this may be required in some cases):
42+
43+
.. code-block:: shell
44+
45+
sudo pip3 install adafruit-circuitpython-pca9685
46+
47+
To install in a virtual environment in your current project:
48+
49+
.. code-block:: shell
50+
51+
mkdir project-name && cd project-name
52+
python3 -m venv .env
53+
source .env/bin/activate
54+
pip3 install adafruit-circuitpython-pca9685
55+
3156
Usage Example
3257
=============
3358

@@ -85,4 +110,4 @@ Now, once you have the virtual environment activated:
85110
86111
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
87112
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
88-
locally verify it will pass.
113+
locally verify it will pass.

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@
3434
author='Radomir Dopieralski & Adafruit Industries',
3535
author_email='[email protected]',
3636

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

3939
# Choose your license
4040
license='MIT',

0 commit comments

Comments
 (0)