File: README.rst

package info (click to toggle)
python-overpy 0.4-1
  • links: PTS, VCS
  • area: main
  • in suites: buster, stretch
  • size: 488 kB
  • ctags: 315
  • sloc: python: 1,986; xml: 1,037; makefile: 7
file content (100 lines) | stat: -rw-r--r-- 2,295 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Python Overpass Wrapper
=======================

A Python Wrapper to access the Overpass API.

Have a look at the `documentation`_ to find additional information.

.. image:: https://pypip.in/version/overpy/badge.svg
    :target: https://pypi.python.org/pypi/overpy/
    :alt: Latest Version

.. image:: https://pypip.in/license/overpy/badge.svg
    :target: https://pypi.python.org/pypi/overpy/
    :alt: License

.. image:: https://travis-ci.org/DinoTools/python-overpy.svg?branch=master
    :target: https://travis-ci.org/DinoTools/python-overpy

.. image:: https://coveralls.io/repos/DinoTools/python-overpy/badge.png?branch=master
    :target: https://coveralls.io/r/DinoTools/python-overpy?branch=master

Features
--------

* Query Overpass API
* Parse JSON and XML response data
* Additional helper functions

Install
-------

**Requirements:**

Supported Python versions:

* Python 2.7
* Python >= 3.2
* PyPy and PyPy3

**Install:**

.. code-block:: console

    $ pip install overpy

Examples
--------

Additional examples can be found in the `documentation`_ and in the *examples* directory.

.. code-block:: python

    import overpy

    api = overpy.Overpass()

    # fetch all ways and nodes
    result = api.query("""
        way(50.746,7.154,50.748,7.157) ["highway"];
        (._;>;);
        out body;
        """)

    for way in result.ways:
        print("Name: %s" % way.tags.get("name", "n/a"))
        print("  Highway: %s" % way.tags.get("highway", "n/a"))
        print("  Nodes:")
        for node in way.nodes:
            print("    Lat: %f, Lon: %f" % (node.lat, node.lon))


Helper
~~~~~~

Helper methods are available to provide easy access to often used requests.

.. code-block:: python

    import overpy.helper

    # 3600062594 is the OSM id of Chemnitz and is the bounding box for the request
    street = overpy.helper.get_street(
        "Strasse der Nationen",
        "3600062594"
    )

    # this finds an intersection between Strasse der Nationen and Carolastrasse in Chemnitz
    intersection = overpy.helper.get_intersection(
        "Strasse der Nationen",
        "Carolastrasse",
        "3600062594"
    )


License
-------

Published under the MIT (see LICENSE for more information)

.. _`documentation`: http://python-overpy.readthedocs.org/