Merge pull request #2 from UmanShahzad/uman/text

Improve `README.md`

Author: UmanShahzad

README.md

@@ -1,27 +1,27 @@
 # [<img src="https://ipinfo.io/static/ipinfo-small.svg" alt="IPinfo" width="24"/>](https://ipinfo.io/) IPinfo Python Client Library
 
 This is the official Python client library for the [IPinfo.io](https://ipinfo.io) IP address API, allowing you to lookup your own IP address, or get any of the following details for an IP:
- - IP geolocation (city, region, country, postal code, latitude and longitude)
- - ASN details (ISP or network operator, associated domain name, and type, such as business, hosting or company)
- - Company details (the name and domain of the business that uses the IP address)
- - Carrier details (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)
 
+- IP geolocation (city, region, country, postal code, latitude and longitude)
+- ASN details (ISP or network operator, associated domain name, and type, such as business, hosting or company)
+- Company details (the name and domain of the business that uses the IP address)
+- Carrier details (the name of the mobile carrier and MNC and MCC for that carrier if the IP is used exclusively for mobile traffic)
 
-### Getting Started
+## Getting Started
 
 You'll need an IPinfo API access token, which you can get by singing up for a free account at [https://ipinfo.io/signup](https://ipinfo.io/signup?ref=lib-Python).
 
 The free plan is limited to 1,000 requests a day, and doesn't include some of the data fields such as IP type and company data. To enable all the data fields and additional request volumes see [https://ipinfo.io/pricing](https://ipinfo.io/pricing?ref=lib-Python)
 
-#### Installation
+### Installation
 
-```
+```bash
 pip install ipinfo
 ```
 
-#### Quick Start
+### Quick Start
 
-```
+```python
 >>> import ipinfo
 >>> access_token = '123456789abc'
 >>> handler = ipinfo.getHandler(access_token)
@@ -33,11 +33,11 @@ Emeryville
 37.8342,-122.2900
 ```
 
-#### Usage
+### Usage
 
 The `Handler.getDetails()` method accepts an IP address as an optional, positional argument. If no IP address is specified, the API will return data for the IP address from which it receives the request.
 
-```
+```python
 >>> import ipinfo
 >>> access_token = '123456789abc'
 >>> handler = ipinfo.getHandler(access_token)
@@ -48,42 +48,40 @@ Emeryville
 37.8342,-122.2900
 ```
 
-#### Authentication
+### Authentication
 
 The IPinfo library can be authenticated with your IPinfo API token, which is passed in as a positional argument. It also works without an authentication token, but in a more limited capacity.
 
-```
->>> access_token = '123456789abc'
->>> handler = ipinfo.getHandler(access_token)
+```python
+>>> import ipinfo
+>>> handler = ipinfo.getHandler(access_token='123456789abc')
 ```
 
-#### Details Data
+### Details Data
 
 `handler.getDetails()` will return a `Details` object that contains all fields listed in the [IPinfo developer docs](https://ipinfo.io/developers/responses#full-response) with a few minor additions. Properties can be accessed directly.
 
-```
+```python
 >>> details.hostname
 cpe-104-175-221-247.socal.res.rr.com
 ```
 
-##### Country Name
-
+#### Country Name
 
 `details.country_name` will return the country name, as supplied by the `countries.json` file. See below for instructions on changing that file for use with non-English languages. `details.country` will still return country code.
 
-```
+```python
 >>> details.country
 US
 >>> details.country_name
 United States
 ```
 
-#### IP Address
-
+### IP Address
 
 `details.ip_address` will return the an `ipaddress` object from the [Python Standard Library](https://docs.python.org/3/library/ipaddress.html). `details.ip` will still return a string.
 
-```
+```python
 >>> details.ip
 104.175.221.247
 >>> type(details.ip)
@@ -94,12 +92,11 @@ United States
 <class 'ipaddress.IPv4Address'>
 ```
 
-##### Longitude and Latitude
-
+#### Longitude and Latitude
 
 `details.latitude` and `details.longitude` will return latitude and longitude, respectively, as strings. `details.loc` will still return a composite string of both values.
 
-```
+```python
 >>> details.loc
 34.0293,-118.3570
 >>> details.latitude
@@ -108,11 +105,11 @@ United States
 -118.3570
 ```
 
-##### Accessing all properties
+#### Accessing all properties
 
 `details.all` will return all details data as a dictionary.
 
-```
+```python
 >>> details.all
 {
 'asn': {  'asn': 'AS20001',
@@ -138,61 +135,67 @@ United States
 }
 ```
 
-#### Caching
+### Caching
 
 In-memory caching of `details` data is provided by default via the [cachetools](https://cachetools.readthedocs.io/en/latest/) library. This uses an LRU (least recently used) cache with a TTL (time to live) by default. This means that values will be cached for the specified duration; if the cache's max size is reached, cache values will be invalidated as necessary, starting with the oldest cached value.
 
-##### Modifying cache options
+#### Modifying cache options
 
 Cache behavior can be modified by setting the `cache_options` keyword argument. `cache_options` is a dictionary in which the keys are keyword arguments specified in the `cachetools` library. The nesting of keyword arguments is to prevent name collisions between this library and its dependencies.
 
-* Default maximum cache size: 4096 (multiples of 2 are recommended to increase efficiency)
-* Default TTL: 24 hours (in seconds)
+- Default maximum cache size: 4096 (multiples of 2 are recommended to increase efficiency)
+- Default TTL: 24 hours (in seconds)
 
-```
+```python
+>>> import ipinfo
 >>> handler = ipinfo.getHandler(cache_options={'ttl':30, 'maxsize': 128})
 ```
 
-##### Using a different cache
+#### Using a different cache
 
-It's possible to use a custom cache by creating a child class of the [CacheInterface](https://github.com/ipinfo/python/blob/master/ipinfo_wrapper/cache/interface.py) class and passing this into the handler object with the `cache` keyword argument. FYI this is known as [the Strategy Pattern](https://sourcemaking.com/design_patterns/strategy).
+It's possible to use a custom cache by creating a child class of the [CacheInterface](https://github.com/ipinfo/python/blob/master/ipinfo/cache/interface.py) class and passing this into the handler object with the `cache` keyword argument. FYI this is known as [the Strategy Pattern](https://sourcemaking.com/design_patterns/strategy).
 
-```
->>> handler = ipinfo.getHandler(cache=my_fancy_custom_class)
+```python
+import ipinfo
+from ipinfo.cache.interface import CacheInterface
+
+class MyCustomCache(CacheInterface):
+    ...
+
+handler = ipinfo.getHandler(cache=MyCustomCache())
 ```
 
-#### Modifying request options
+### Modifying request options
 
 Request behavior can be modified by setting the `request_options` keyword argument. `request_options` is a dictionary in which the keys are keyword arguments specified in the `requests` library. The nesting of keyword arguments is to prevent name collisions between this library and its dependencies.
 
-* Default request timeout: 2 seconds
+- Default request timeout: 2 seconds
 
-```
+```python
 >>> handler = ipinfo.getHandler(request_options={'timeout': 4})
 ```
 
-
-#### Internationalization
+### Internationalization
 
 When looking up an IP address, the response object includes a `details.country_name` attribute which includes the country name based on American English. It is possible to return the country name in other languages by setting the `countries_file` keyword argument when creating the `IPinfo` object.
 
 The file must be a `.json` file with the following structure:
 
-```
+```json
 {
- "BD": "Bangladesh",
- "BE": "Belgium",
- "BF": "Burkina Faso",
- "BG": "Bulgaria"
- ...
+  "BD": "Bangladesh",
+  "BE": "Belgium",
+  "BF": "Burkina Faso",
+  "BG": "Bulgaria",
+  ...
 }
 ```
 
-### Other Libraries
+## Other Libraries
 
 There are official IPinfo client libraries available for many languages including PHP, Go, Java, Ruby, and many popular frameworks such as Django, Rails and Laravel. There are also many third party libraries and integrations available for our API.
 
-### About IPinfo
+## About IPinfo
 
 Founded in 2013, IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier and IP type data sets. Our API handles over 12 billion requests a month for 100,000 businesses and developers.
 

setup.py

@@ -1,6 +1,12 @@
 from setuptools import setup
 
-long_description = 'The official Python library for IPinfo. IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere. We process terabytes of data to produce our custom IP geolocation, company, carrier and IP type data sets. You can visit our developer docs at https://ipinfo.io/developers.'
+long_description = """
+The official Python library for IPinfo.
+
+IPinfo prides itself on being the most reliable, accurate, and in-depth source of IP address data available anywhere.
+We process terabytes of data to produce our custom IP geolocation, company, carrier and IP type data sets.
+You can visit our developer docs at https://ipinfo.io/developers.
+"""
 
 setup(name='ipinfo',
       version='1.1.0',