From f9ee62989f833f906ebb6217080b917ea382ce65 Mon Sep 17 00:00:00 2001 From: brentru Date: Fri, 3 Jan 2020 14:19:44 -0500 Subject: [PATCH] add install instructions to README, enable setup.py --- README.rst | 24 ++++++++++++++++++++++++ setup.py.disabled => setup.py | 0 2 files changed, 24 insertions(+) rename setup.py.disabled => setup.py (100%) diff --git a/README.rst b/README.rst index aa7f7d9..3c77ee6 100644 --- a/README.rst +++ b/README.rst @@ -16,6 +16,30 @@ Adafruit_CircuitPython_AzureIoT Access to `Microsoft Azure IoT `_ from a CircuitPython device. This library can perform device messaging services (cloud-to-device, device-to-cloud), device services, and job services. +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-azureiot + +To install system-wide (this may be required in some cases): + +.. code-block:: shell + + sudo pip3 install adafruit-circuitpython-azureiot + +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-azureiot + Dependencies ============= This driver depends on: diff --git a/setup.py.disabled b/setup.py similarity index 100% rename from setup.py.disabled rename to setup.py