update readme, setup, lib

Author: brentru

README.rst

@@ -27,49 +27,30 @@ Please ensure all dependencies are available on the CircuitPython filesystem.
 This is easily achieved by downloading
 `the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
 
-Installing from PyPI
---------------------
-.. note:: This library is not available on PyPI yet. Install documentation is included
-   as a standard element. Stay tuned for PyPI availability!
-.. todo:: Remove the above note if PyPI version is/will be available at time of release.
-   If the library is not planned for PyPI, remove the entire 'Installing from PyPI' section.
-On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
-PyPI <https://pypi.org/project/adafruit-circuitpython-adafruit_io/>`_. To install for current user:
-
-.. code-block:: shell
-
-    pip3 install adafruit-circuitpython-adafruit_io
-
-To install system-wide (this may be required in some cases):
-
-.. code-block:: shell
-
-    sudo pip3 install adafruit-circuitpython-adafruit_io
-
-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-adafruit_io
-
 Usage Example
 =============
 
 Create an Adafruit IO Client object
 .. code-block:: python
-        aio = adafruit_io.Client(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi)
+        io = RESTClient(ADAFRUIT_IO_USER, ADAFRUIT_IO_KEY, wifi)
 
 Sending `data` to an Adafruit IO feed
 .. code-block:: python
-        aio.send_data(my_adafruit_io_feed, data)
+        io.send_data(feed, data)
 
 Receiving `data` from an Adafruit IO feed
 .. code-block:: python
-        data = aio.receive_data(my_adafruit_io_feed)
+        data = io.receive_data(feed)
+
+Creating a new feed named `circuitpython` with a description
+.. code-block:: python
+        feed = io.create_new_feed('circuitpython', 'an Adafruit IO CircuitPython feed')
+
+Listing the record of a specified feed:
+.. code-block:: python
+    feed = io.get_feed('circuitpython')
 
+More usage examples are included in the `examples folder of this repository<<https://github.com/adafruit/Adafruit_CircuitPython_Adafruit_IO/blob/examples>`_
 
 Contributing
 ============

adafruit_io.py

@@ -25,7 +25,6 @@
 
 A CircuitPython/Python library for communicating with Adafruit IO
 
-
 * Author(s): Brent Rubell for Adafruit Industries
 
 Implementation Notes
@@ -40,19 +39,17 @@
     https://github.com/adafruit/Adafruit_CircuitPython_ESP32SPI
 """
 
-# imports
-
 __version__ = "0.0.0-auto.0"
 __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Adafruit_IO.git"
 
 class AdafruitIO_ThrottleError(Exception):
-    """Adafruit IO request error class for Throttle Errors"""
+    """Adafruit IO request error class for rate-limiting"""
     def __init__(self):
         super(AdafruitIO_ThrottleError, self).__init__("Number of Adafruit IO Requests exceeded! \
                                                             Please try again in 30 seconds..")
 
 class AdafruitIO_RequestError(Exception):
-    """Base Adafruit IO request error class"""
+    """Adafruit IO request error class"""
     def __init__(self, response):
         response_content = response.json()
         error = response_content['error']
@@ -63,18 +60,15 @@ class RESTClient():
     """
     REST Client for interacting with the Adafruit IO API.
     """
-    def __init__(self, username, key, wifi_manager, api_version='v2'):
-        """
-        Creates an instance of the Adafruit IO REST Client
-        :param str username: Adafruit IO Username
-        :param str key: Adafruit IO Key
-        :param wifi_manager: WiFiManager Object
-        :param str api_version: Adafruit IO REST API Version
-        """
-        self.api_version = api_version
-        self.url = 'https://io.adafruit.com/api'
-        self.username = username
-        self.key = key
+    def __init__(self, adafruit_io_username, adafruit_io_key, wifi_manager):
+        """
+        Creates an instance of the Adafruit IO REST Client.
+        :param str adafruit_io_username: Adafruit IO Username
+        :param str adafruit_io_key: Adafruit IO Key
+        :param wifi_manager: WiFiManager object from adafruit_esp32spi_wifimanager
+        """
+        self.username = adafruit_io_username
+        self.key = adafruit_io_key
         if wifi_manager:
             self.wifi = wifi_manager
         else:
@@ -96,10 +90,9 @@ def _handle_error(response):
             raise AdafruitIO_RequestError(response)
         elif response.status_code >= 400:
             raise AdafruitIO_RequestError(response)
-        # no error? do nothing
 
     def _compose_path(self, path):
-        return "{0}/{1}/{2}/{3}".format(self.url, self.api_version, self.username, path)
+        return "{0}/{1}/{2}/{3}".format('https://io.adafruit.com/api', 'v2', self.username, path)
 
     # HTTP Requests
     def _post(self, path, payload):
@@ -184,7 +177,8 @@ def create_new_group(self, group_key, group_description):
         :param str group_description: Brief summary about the group
         """
         path = self._compose_path("groups")
-        payload = {'name':group_key, 'description':group_description}
+        payload = {'name':group_key,
+                   'description':group_description}
         return self._post(path, payload)
 
     def delete_group(self, group_key):

setup.py

@@ -17,7 +17,7 @@
     long_description = f.read()
 
 setup(
-    name='adafruit-circuitpython-adafruit_io',
+    name='adafruit-circuitpython-adafruitio',
 
     use_scm_version=True,
     setup_requires=['setuptools_scm'],
@@ -27,7 +27,7 @@
     long_description_content_type='text/x-rst',
 
     # The project's main homepage.
-    url='https://github.com/adafruit/Adafruit_CircuitPython_Adafruit_IO',
+    url='https://github.com/adafruit/Adafruit_CircuitPython_AdafruitIO',
 
     # Author details
     author='Adafruit Industries',
@@ -59,7 +59,5 @@
 
     # You can just specify the packages manually here if your project is
     # simple. Or you can use find_packages().
-    # TODO: IF LIBRARY FILES ARE A PACKAGE FOLDER,
-    #       CHANGE `py_modules=['...']` TO `packages=['...']`
     py_modules=['adafruit_adafruit_io'],
 )