Skip to content

Commit ec5fe1b

Browse files
committed
update readme
1 parent e3e20e4 commit ec5fe1b

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,18 @@
22

33
This is a thin wrapper around the OpenStreetMap [Overpass API](http://wiki.openstreetmap.org/wiki/Overpass_API).
44

5-
## Use it
5+
## Install it
6+
7+
```
8+
python setup.py install
9+
```
610

7-
You need to have the `requests` module [installed](http://docs.python-requests.org/en/latest/user/install/#install).
11+
The module is not on PyPi yet.
12+
13+
## Use it
814

915
```
10-
>>> import Overpass
16+
>>> from overpass import Overpass
1117
>>> api = Overpass.API()
1218
>>> response = api.Get('node["name"="Salt Lake City"]')
1319
```
@@ -41,6 +47,10 @@ The default timeout is 25 seconds, but you can set it to whatever you want.
4147

4248
Setting this to `True` will get you debug output.
4349

50+
#### `bbox`
51+
52+
This takes a list in the form `[minlon, minlat, maxlon, maxlat]`, the default is the world: `[-180.0, -90.0, 180.0, 90.0]`
53+
4454
## Need help? Want feature?
4555

4656
Create a [new issue](https://github.com/mvexel/overpass-api-python-wrapper/issues).

0 commit comments

Comments
 (0)