From ee1fadfa6c761a0c6968874f27de073d0af03e08 Mon Sep 17 00:00:00 2001
From: Saleem Latif <saleem_ee@hotmail.com>
Date: Fri, 22 Jan 2016 12:09:45 +0500
Subject: [PATCH] Code refactor

---
 README.md                                        | 13 +++++++++----
 geocode/{geocode_exceptions.py => exceptions.py} |  0
 geocode/geocode.py                               |  4 ++--
 geocode/{helper_functions.py => helpers.py}      |  0
 4 files changed, 11 insertions(+), 6 deletions(-)
 rename geocode/{geocode_exceptions.py => exceptions.py} (100%)
 rename geocode/{helper_functions.py => helpers.py} (100%)

diff --git a/README.md b/README.md
index d6bd1ae..7707d1d 100644
--- a/README.md
+++ b/README.md
@@ -5,6 +5,15 @@ Python wrapper for google's geoode REST API
 
 GeoCode allows you to retrieve latitude longitude for an address or vice versa.
 
+__Setup:__
+
+Follow these steps to setup GeoCode locally.
+
+* Clone GeoCode repository `git clone https://github.com/saleem-latif/GeoCode.git`
+* Create and activate [virtual environment](https://virtualenv.readthedocs.org/en/latest/userguide.html).
+* install requirements `pip install -r geocode/requirements.txt`
+* run tests `python geocode/tests/unittest_geocode.py`
+
 __Example Usage:__
 
 `geo_code = GeoCodeAccessAPI(address="Sydney, NSW")`
@@ -16,7 +25,3 @@ __Accessing latitude/longitude or Address:__
 `lng = geo_code.lng`
 
 `address = geo_code.address`
-
-Note:
-  Code need to be tested and documented properly.
-  
diff --git a/geocode/geocode_exceptions.py b/geocode/exceptions.py
similarity index 100%
rename from geocode/geocode_exceptions.py
rename to geocode/exceptions.py
diff --git a/geocode/geocode.py b/geocode/geocode.py
index 5ae8faf..09e9833 100644
--- a/geocode/geocode.py
+++ b/geocode/geocode.py
@@ -2,8 +2,8 @@
 from xml.etree import ElementTree
 
 from constants import geo_code_url, parameter_names_map, STATUS_OK, STATUS_UNKNOWN, google_geocode_response_tags
-from geocode_exceptions import APIError
-from helper_functions import encode_geocode_url
+from exceptions import APIError
+from helpers import encode_geocode_url
 
 
 class GeoCode(object):
diff --git a/geocode/helper_functions.py b/geocode/helpers.py
similarity index 100%
rename from geocode/helper_functions.py
rename to geocode/helpers.py