Improve example and readme

README.md

@@ -1 +1,66 @@
 # GeoScraper
+[![GitHub version](https://badge.fury.io/gh/PowerBroker2%2FGeoScraper.svg)](https://badge.fury.io/gh/PowerBroker2%2FGeoScraper) [![PyPI version](https://badge.fury.io/py/GeoScraper.svg)](https://badge.fury.io/py/GeoScraper)<br /><br />
+
+Very user friendly library to parse OpenSourceMap data either from an XML file (i.e. *.osm), from an OSM API URL, or from a user specified bounding box.
+
+# To Install
+```
+pip install GeoScraper
+```
+
+# Example Python Script
+```python
+import os
+from pprint import pprint
+
+from GeoScraper import GeoScraper
+
+
+USE_BBOX  = True
+USE_FILE  = True
+USE_URL   = True
+
+XML_FNAME = os.path.join(os.path.dirname(__file__), 'map.osm') # YOU MAY NEED TO CHANGE THIS LINE!
+BBOX = [-84.0958000, # left
+         39.7617000, # bottom
+        -84.0484000, # right
+         39.7823000] # top
+URL = r'https://api.openstreetmap.org/api/0.6/map?bbox=-84.0958000,39.7617000,-84.0484000,39.7823000'
+
+
+if __name__ == '__main__':
+    scraper = GeoScraper()
+
+    if USE_FILE:
+        print('=' * 50)
+        print('Using file:')
+        print('=' * 50)
+        scraper.from_file(XML_FNAME)
+        pprint(scraper.highways()[:3])
+        print('\n')
+
+    if USE_BBOX:
+        print('=' * 50)
+        print('Using bbox:')
+        print('=' * 50)
+        scraper.from_bbox(left   = BBOX[0],
+                          bottom = BBOX[1],
+                          right  = BBOX[2],
+                          top    = BBOX[3])
+        pprint(scraper.highways()[:3])
+        print('\n')
+        print('=' * 50)
+        print('Done')
+        print('=' * 50)
+
+    if USE_URL:
+        print('=' * 50)
+        print('Using url:')
+        print('=' * 50)
+        scraper.from_url(URL)
+        pprint(scraper.highways()[:3])
+        print('\n')
+        print('=' * 50)
+        print('Done')
+        print('=' * 50)
+```

examples/basic_example.py

@@ -4,29 +4,50 @@
 from GeoScraper import GeoScraper
 
 
-XML_FNAME = os.path.join(os.path.dirname(__file__),
-                         'map.osm')
+USE_BBOX  = True
+USE_FILE  = True
+USE_URL   = True
+
+XML_FNAME = os.path.join(os.path.dirname(__file__), 'map.osm') # YOU MAY NEED TO CHANGE THIS LINE!
+BBOX = [-84.0958000, # left
+         39.7617000, # bottom
+        -84.0484000, # right
+         39.7823000] # top
+URL = r'https://api.openstreetmap.org/api/0.6/map?bbox=-84.0958000,39.7617000,-84.0484000,39.7823000'
 
 
 if __name__ == '__main__':
     scraper = GeoScraper()
 
-    # print('=' * 50)
-    # print('Using file:')
-    # print('=' * 50)
-    # scraper.from_file(XML_FNAME)
-    # pprint(scraper.highways()[:3])
-    # print('\n')
+    if USE_FILE:
+        print('=' * 50)
+        print('Using file:')
+        print('=' * 50)
+        scraper.from_file(XML_FNAME)
+        pprint(scraper.highways()[:3])
+        print('\n')
+
+    if USE_BBOX:
+        print('=' * 50)
+        print('Using bbox:')
+        print('=' * 50)
+        scraper.from_bbox(left   = BBOX[0],
+                          bottom = BBOX[1],
+                          right  = BBOX[2],
+                          top    = BBOX[3])
+        pprint(scraper.highways()[:3])
+        print('\n')
+        print('=' * 50)
+        print('Done')
+        print('=' * 50)
 
-    print('=' * 50)
-    print('Using bbox:')
-    print('=' * 50)
-    scraper.from_bbox(left   = -84.0958000,
-                      bottom =  39.7617000,
-                      right  = -84.0484000,
-                      top    =  39.7823000)
-    pprint(scraper.highways()[:3])
-    print('\n')
-    print('=' * 50)
-    print('Done')
-    print('=' * 50)
+    if USE_URL:
+        print('=' * 50)
+        print('Using url:')
+        print('=' * 50)
+        scraper.from_url(URL)
+        pprint(scraper.highways()[:3])
+        print('\n')
+        print('=' * 50)
+        print('Done')
+        print('=' * 50)