Merge pull request #4 from UmanShahzad/uman/docstrings

Add docstrings everywhere it may be useful.

Author: coderholic

ipinfo/cache/default.py

@@ -1,3 +1,7 @@
+"""
+A default cache implementation that uses `cachetools` for an in-memory LRU cache.
+"""
+
 import cachetools
 from .interface import CacheInterface
 

ipinfo/cache/interface.py

@@ -1,3 +1,7 @@
+"""
+Abstract interface for caching IPinfo data.
+"""
+
 import abc
 
 

ipinfo/details.py

@@ -1,3 +1,7 @@
+"""
+Details returned by the IPinfo service.
+"""
+
 class Details:
     """Encapsulates data for single IP address."""
 

ipinfo/exceptions.py

@@ -1,3 +1,7 @@
+"""
+Exceptions thrown by the IPinfo service.
+"""
+
 class RequestQuotaExceededError(Exception):
     """Error indicating that users monthly request quota has been passed."""
     pass

ipinfo/handler.py

@@ -1,6 +1,9 @@
+"""
+Main API client handler for fetching data from the IPinfo service.
+"""
+
 import ipaddress
 import json
-import operator
 import os
 import requests
 import sys
@@ -9,7 +12,7 @@
 from .exceptions import RequestQuotaExceededError
 
 
-class Handler():
+class Handler:
     """
     Allows client to request data for specified IP address. Instantiates and
     and maintains access to cache.