Add Docstrings

Author: smashedr

README.md

@@ -77,7 +77,7 @@ vultr = Vultr('VULTR_API_KEY')
 List plans and get available regions for that plan
 
 ```python
-plans = vultr.list_plans({'type': 'vc2'})  # vc2 - Cloud Compute
+plans = vultr.list_plans({'type': 'vc2'})  # Filter by type
 plan = plans[0]  # 0 seems to be the base plan
 regions = vultr.list_regions()
 available = vultr.filter_regions(regions, plan['locations'])

docs/index.md

@@ -54,7 +54,7 @@ vultr = Vultr('VULTR_API_KEY')
 List plans and get available regions for that plan
 
 ```python
-plans = vultr.list_plans({'type': 'vc2'})  # vc2 - Cloud Compute
+plans = vultr.list_plans({'type': 'vc2'})  # Filter by type
 plan = plans[0]  # 0 seems to be the base plan
 regions = vultr.list_regions()
 available = vultr.filter_regions(regions, plan['locations'])

src/vultr/vultr.py

@@ -9,23 +9,47 @@ class Vultr(object):
 
     def __init__(self, api_key: Optional[str] = None):
         """
-        :param str api_key: Vultr API Key or VULTR_API_KEY Environment Variable
+        :param api_key: Vultr API Key or `VULTR_API_KEY` Environment Variable
         """
         self.api_key = api_key or os.getenv("VULTR_API_KEY")
+        """Provide the API key here or with the `VULTR_API_KEY` environment variable"""
         self._session = requests.session()
         if self.api_key:
             self._session.headers.update({"Authorization": f"Bearer {self.api_key}"})
 
     def get(self, url: str, params: Optional[dict] = None):
+        """
+        GET Data
+        :param url: Request URL. Example `/instances`
+        :param params: Query Parameters
+        :return: Response Data
+        """
         return self._get(f"{self.url}/{url.lstrip('/')}", params)
 
     def post(self, url: str, **kwargs):
+        """
+        POST Data
+        :param url: Request URL. Example `/instances`
+        :param kwargs: Request Data Keyword Arguments
+        :return: Response Data
+        """
         return self._post(f"{self.url}/{url.lstrip('/')}", kwargs)
 
     def patch(self, url: str, **kwargs):
+        """
+        PATCH Data
+        :param url: Request URL. Example `/instances/{resource_id}`
+        :param kwargs: Request Data Keyword Arguments
+        :return: Response Data
+        """
         return self._patch(f"{self.url}/{url.lstrip('/')}", kwargs)
 
     def delete(self, url: str):
+        """
+        DELETE a Resource
+        :param url: Request URL. Example `/instances/{resource_id}`
+        :return: None
+        """
         return self._delete(f"{self.url}/{url.lstrip('/')}")
 
     def list_os(self, params: Optional[dict] = None):
@@ -193,13 +217,16 @@ def _get_obj_key(obj, key="id"):
 
 
 class VultrException(Exception):
+    """ Exception class for all Vultr error responses. """
     def __init__(self, response: requests.Response):
         try:
             data = response.json()
             error = data.get("error", response.text)
         except ValueError:
             error = response.text
         status = response.status_code
-        self.error = error
-        self.status = status
+        self.error: str = error
+        """Error Message returned from the API"""
+        self.status: int = status
+        """Response Status Code"""
         super().__init__(f"Error {self.status}: {self.error}")