From dca1bb7b1db7f46160c8e03ac7ed3af85e7b1a18 Mon Sep 17 00:00:00 2001 From: Kattni Rembor Date: Tue, 24 Sep 2019 13:25:30 -0400 Subject: [PATCH] Update version info, README --- README.rst | 24 ++++++++++++++++++++++++ adafruit_thermistor.py | 6 +++++- 2 files changed, 29 insertions(+), 1 deletion(-) diff --git a/README.rst b/README.rst index c9d79b3..e402acf 100644 --- a/README.rst +++ b/README.rst @@ -28,6 +28,30 @@ Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading `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-thermistor + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-thermistor + +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-thermistor + Usage Example ============= diff --git a/adafruit_thermistor.py b/adafruit_thermistor.py index 6dcbc19..9378eaa 100644 --- a/adafruit_thermistor.py +++ b/adafruit_thermistor.py @@ -20,7 +20,7 @@ # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. """ -`adafruit_thermistor` - Read temperature with a thermistor +`adafruit_thermistor` =========================================================== A thermistor is a resistor that varies with temperature. This driver takes the @@ -57,6 +57,10 @@ import math import analogio +__version__ = "0.0.0-auto.0" +__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Thermistor.git" + + class Thermistor: """Thermistor driver"""