Adding debugging (fixes #2) and don't require full QL syntax (fixes #1)

Author: mvexel

Overpass.py

@@ -8,10 +8,12 @@ class API(object):
     # defaults for the API class
     TIMEOUT = 25  # seconds
     ENDPOINT = "http://overpass-api.de/api/interpreter"
+    DEBUG = False
 
     def __init__(self,
                  endpoint=None,
                  timeout=None,
+                 debug=None
                  ):
         if endpoint is None:
             self.endpoint = self.ENDPOINT
@@ -21,12 +23,27 @@ def __init__(self,
             self.timeout = self.TIMEOUT
         else:
             self.timeout = timeout
-        self.status = None
+        if debug is None:
+            self.debug = self.DEBUG
+        else:
+            self.debug = debug
+        self._status = None
+
+        if self.debug:
+            import httplib
+            import logging
+            httplib.HTTPConnection.debuglevel = 1
+
+            logging.basicConfig()
+            logging.getLogger().setLevel(logging.DEBUG)
+            requests_log = logging.getLogger("requests.packages.urllib3")
+            requests_log.setLevel(logging.DEBUG)
+            requests_log.propagate = True
 
     def Get(self, query):
         """Pass in an Overpass query in Overpass XML or Overpass QL"""
 
-        payload = {"data": query}
+        payload = {"data": self._ConstructQLQuery(query)}
 
         try:
             r = requests.get(self.endpoint, params=payload, timeout=self.timeout)
@@ -36,12 +53,12 @@ def Get(self, query):
                 'Try passing in a higher value when instantiating this API:'
                 'api = Overpass.API(timeout=60)'.format(timeout=self.timeout))
 
-        self.status = r.status_code
+        self._status = r.status_code
 
-        if self.status != 200:
-            if self.status == 400:
+        if self._status != 200:
+            if self._status == 400:
                 return self._ConstructError('Query syntax error')
-            elif self.status == 500:
+            elif self._status == 500:
                 return self._ConstructError('Overpass internal server error')
 
         response = json.loads(r.text)
@@ -53,6 +70,13 @@ def Get(self, query):
 
     def _ConstructError(self, msg):
         return {
-            "status": self.status,
+            "status": self._status,
             "message": msg
         }
+
+    def _ConstructQLQuery(self, userquery):
+        if self.debug:
+            print "[out:json];" + userquery + "out body;"
+        if not userquery.endswith(";"):
+            userquery += ";"
+        return "[out:json];" + userquery + "out body;"

README.md

@@ -7,16 +7,38 @@ This is a thin wrapper around the OpenStreetMap [Overpass API](http://wiki.opens
 ```
 >>> import Overpass
 >>> api = Overpass.API()
->>> response = api.Get('[out:json];node["name":"Salt Lake City"];out body;')
+>>> response = api.Get('node["name":"Salt Lake City"]')
 ```
 
+Note that you don't have to include any of the output meta statements. The wrapper will, well, wrap those.
+
 You will get your result as a dictionary, which (for now) represents the JSON output you would get [from the Overpass API directly](http://overpass-api.de/output_formats.html#json). So you could do this for example:
 
 ```
 >>> print [(feature['tags']['name'], feature['id']) for feature in response['elements']]
 [(u'Salt Lake City', 150935219), (u'Salt Lake City', 585370637), (u'Salt Lake City', 1615721573)]
 ```
 
+### Parameters
+
+The API takes a few parameters:
+
+#### `endpoint`
+
+The default endpoint is `http://overpass-api.de/api/interpreter` but you can pass in the rambler instance (`http://overpass.osm.rambler.ru/cgi/interpreter`) or your own:
+
+    api = Overpass.API(endpoint=http://overpass.myserver/interpreter)
+
+#### `timeout`
+
+The default timeout is 25 seconds, but you can set it to whatever you want.
+
+    api = Overpass.API(timeout=600)
+
+#### `debug`
+
+Setting this to `True` will get you debug output.
+
 ## Fork it
 
 [Yes please](https://github.com/mvexel/overpass-api-python-wrapper/fork).