This commit is contained in:
Kattni Rembor 2019-09-19 17:56:43 -04:00
parent 53bf421dbe
commit c3dd04c764
2 changed files with 29 additions and 2 deletions

View File

@ -25,7 +25,32 @@ This driver depends on:
Please ensure all dependencies are available on the CircuitPython filesystem. Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_. `the Adafruit library and driver bundle <https://circuitpython.org/libraries>`_.
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-max31865/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-max31865
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-max31865
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-max31865
Usage Example Usage Example
============= =============
@ -84,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 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 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.

View File

@ -55,6 +55,8 @@ from micropython import const
import adafruit_bus_device.spi_device as spi_device import adafruit_bus_device.spi_device as spi_device
__version__ = "0.0.0-auto.0"
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_MAX31865.git"
#pylint: disable=bad-whitespace #pylint: disable=bad-whitespace
# Register and other constant values: # Register and other constant values: