Add docstrings.

Author: jhtimmins

ipinfo_wrapper/__init__.py

@@ -1,4 +1,6 @@
 from .handler import Handler
 
+
 def getHandler(access_token=None, **kwargs):
+    """Create and return Handler object."""
     return Handler(access_token, **kwargs)

ipinfo_wrapper/cache/default.py

@@ -1,7 +1,9 @@
-from .interface import CacheInterface
 import cachetools
+from .interface import CacheInterface
+
 
 class DefaultCache(CacheInterface):
+    """Default, in-memory cache."""
 
     def __init__(self, maxsize, ttl, **cache_options):
         self.cache = cachetools.TTLCache(maxsize, ttl, **cache_options)

ipinfo_wrapper/cache/interface.py

@@ -1,6 +1,8 @@
 import abc
 
+
 class CacheInterface(metaclass=abc.ABCMeta):
+    """Interface for using custom cache."""
 
     @abc.abstractmethod
     def __contains__(self, key):

ipinfo_wrapper/details.py

@@ -1,14 +1,18 @@
 class Details:
+    """Encapsulates data for single IP address."""
 
     def __init__(self, details):
+        """Initialize by settings `details` attribute."""
         self.details = details
 
     def __getattr__(self, attr):
+        """Return attribute if it exists in details array, else return error."""
         if attr in self.details:
             return self.details[attr]
         else:
             raise AttributeError('{attr} is not a valid attribute of Details'.format(attr))
 
     @property
     def all(self):
+        """Return all details as dict."""
         return self.details

ipinfo_wrapper/exceptions.py

@@ -1,2 +1,3 @@
 class RequestQuotaExceededError(Exception):
+    """Error indicating that users monthly request quota has been passed."""
     pass

ipinfo_wrapper/handler.py

@@ -8,14 +8,20 @@
 from .details import Details
 from .exceptions import RequestQuotaExceededError
 
+
 class Handler():
+    """
+    Allows client to request data for specified IP address. Instantiates and
+    and maintains access to cache.
+    """
 
     API_URL = 'https://ipinfo.io'
     CACHE_MAXSIZE = 4096
     CACHE_TTL = 60 * 60 * 24
     COUNTRY_FILE_DEFAULT = 'countries.json'
 
     def __init__(self, access_token=None, **kwargs):
+        """Initialize the Handler object with country name list and the cache initialized."""
         self.access_token = access_token
         self.countries = self._read_country_names(kwargs.get('countries_file'))
 
@@ -27,20 +33,22 @@ def __init__(self, access_token=None, **kwargs):
             ttl = cache_options.get('ttl', self.CACHE_TTL)
             self.cache = DefaultCache(maxsize, ttl, **cache_options)
 
-    def getDetails(self, ip_address = None):
+    def getDetails(self, ip_address=None):
+        """Get details for specified IP address as a Details object."""
         raw_details = self._requestDetails(ip_address)
         raw_details['country_name'] = self.countries.get(raw_details.get('country'))
         raw_details['ip_address'] = ipaddress.ip_address(raw_details.get('ip'))
 
         lat, lon = None, None
-        coords = tuple(raw_details.get('loc','').split(','))
+        coords = tuple(raw_details.get('loc', '').split(','))
         if coords:
             lat, lon = coords[0], coords[1]
         raw_details['latitude'], raw_details['longitude'] = lat, lon
 
         return Details(raw_details)
 
-    def _requestDetails(self, ip_address = None):
+    def _requestDetails(self, ip_address=None):
+        """Get IP address data by sending request to IPinfo API."""
         if ip_address not in self.cache:
             url = self.API_URL
             if ip_address:
@@ -55,6 +63,7 @@ def _requestDetails(self, ip_address = None):
         return self.cache[ip_address]
 
     def _get_headers(self):
+        """Built headers for request to IPinfo API."""
         headers = {
             'user-agent': 'IPinfoClient/Python{version}/1.0'.format(version=sys.version_info[0]),
             'accept': 'application/json'
@@ -65,7 +74,8 @@ def _get_headers(self):
 
         return headers
 
-    def _read_country_names(self, countries_file = None):
+    def _read_country_names(self, countries_file=None):
+        """Read list of countries from specified country file or default file."""
         if not countries_file:
             countries_file = os.path.join(os.path.dirname(__file__), self.COUNTRY_FILE_DEFAULT)
         with open(countries_file) as f:

setup.py

@@ -1,12 +1,16 @@
 from setuptools import setup
 
 setup(name='ipinfo_wrapper',
-      version='0.1.3',
+      version='0.1.4',
       description='Official Python library for IPInfo',
       url='https://github.com/ipinfo/python',
       author='James Timmins',
       author_email='[email protected]',
       license='Apache License 2.0',
       packages=['ipinfo_wrapper', 'ipinfo_wrapper.cache'],
+      install_requires=[
+        'requests',
+        'cachetools',
+      ],
       include_package_data=True,
       zip_safe=False)