From c3dd04c7646321a5572790e38490dda7588ca4bf Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Thu, 19 Sep 2019 17:56:43 -0400 Subject: [PATCH] Fixes #12 --- README.rst | 29 +++++++++++++++++++++++++++-- adafruit_max31865.py | 2 ++ 2 files changed, 29 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 8a245e4..6056157 100644 --- a/README.rst +++ b/README.rst @@ -25,7 +25,32 @@ This driver depends on: Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading -`the Adafruit library and driver bundle `_. +`the Adafruit library and driver bundle `_. + +Installing from PyPI +===================== +On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from +PyPI `_. 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 ============= @@ -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 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. \ No newline at end of file +locally verify it will pass. diff --git a/adafruit_max31865.py b/adafruit_max31865.py index 4209cd1..96b1ef4 100644 --- a/adafruit_max31865.py +++ b/adafruit_max31865.py @@ -55,6 +55,8 @@ from micropython import const 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 # Register and other constant values: