Skip to content

Commit c64d6f7

Browse files
authored
Merge pull request #4 from adafruit/pypi_readme
add pypi instructions to README.rst
2 parents 0a6f3af + 02ed2b5 commit c64d6f7

File tree

2 files changed

+27
-5
lines changed

2 files changed

+27
-5
lines changed

.travis.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ deploy:
2323
install:
2424
- pip install -r requirements.txt
2525
- pip install pylint circuitpython-build-tools Sphinx sphinx-rtd-theme
26+
- pip install --force-reinstall pylint==1.9.2
2627
script:
2728
- pylint adafruit_as726x.py
2829
- ([[ ! -d "examples" ]] || pylint --disable=missing-docstring,invalid-name,bad-whitespace examples/*.py)

README.rst

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ Introduction
1515

1616
Driver for the AS726x spectral sensors
1717

18-
Dependencies
19-
=============
18+
Installation and Dependencies
19+
=============================
20+
2021
This driver depends on:
2122

2223
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
@@ -27,14 +28,34 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
2728
This is easily achieved by downloading
2829
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
2930

31+
Installing from PyPI
32+
--------------------
33+
34+
On the Raspberry Pi and other Linux systems, you can install the driver locally
35+
`from PyPI <https://pypi.org/project/adafruit-circuitpython-as726x/>`_. To
36+
install system-wide, use:
37+
38+
.. code-block:: shell
39+
40+
sudo pip3 install adafruit-circuitpython-as726x
41+
42+
To install in a virtual environment in your current project:
43+
44+
.. code-block:: shell
45+
46+
mkdir project-name && cd project-name
47+
python3 -m venv .env
48+
source .env/bin/activate
49+
pip3 install adafruit-circuitpython-as726x
50+
3051
Contributing
3152
============
3253

3354
Contributions are welcome! Please read our `Code of Conduct
3455
<https://github.com/adafruit/adafruit_CircuitPython_AS726x/blob/master/CODE_OF_CONDUCT.md>`_
3556
before contributing to help this project stay welcoming.
3657

37-
Building locally
58+
Building Locally
3859
================
3960

4061
Zip release files
@@ -61,8 +82,8 @@ Then run the build:
6182
6283
circuitpython-build-bundles --filename_prefix adafruit-circuitpython-as726x --library_location .
6384
64-
Sphinx documentation
65-
-----------------------
85+
Sphinx Documentation
86+
--------------------
6687

6788
Sphinx is used to build the documentation based on rST files and comments in the code. First,
6889
install dependencies (feel free to reuse the virtual environment from above):

0 commit comments

Comments
 (0)