Skip to content

Commit 133849a

Browse files
authored
Merge pull request #9 from adafruit/pypi-readme-update
PyPI installation added to README
2 parents 589e3e9 + 6f16ec8 commit 133849a

File tree

1 file changed

+27
-3
lines changed

1 file changed

+27
-3
lines changed

README.rst

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ and ambient light color over I2C. Its available on
1919
`Adafruit as a breakout <https://www.adafruit.com/product/3595>`_.
2020

2121

22-
Dependencies
23-
=============
22+
Installation and Dependencies
23+
=============================
2424
This driver depends on:
2525

2626
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
@@ -29,6 +29,30 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2929
This is easily achieved by downloading
3030
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
3131

32+
Installing from PyPI
33+
--------------------
34+
35+
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from PyPI <https://pypi.org/project/adafruit-circuitpython-apds9960/>`_. To install for current user:
36+
37+
.. code-block:: shell
38+
39+
pip3 install adafruit-circuitpython-apds9960
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-apds9960
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-apds9960
55+
3256
Usage Example
3357
=============
3458

@@ -168,4 +192,4 @@ Now, once you have the virtual environment activated:
168192
169193
This will output the documentation to ``docs/_build/html``. Open the index.html in your browser to
170194
view them. It will also (due to -W) error out on any warning like Travis will. This is a good way to
171-
locally verify it will pass.
195+
locally verify it will pass.

0 commit comments

Comments
 (0)