pyroutelib3

Library for simple routing on OSM data


Keywords
osm, routing, pyroutelib, router, openstreetmap, python3-library
License
GPL-3.0
Install
pip install pyroutelib3==1.7.2

Documentation

pyroutelib3

A continuation of pyroutelib2. Routing on OSM data in Python 3.

OSM Data tiles is stored in tilescache/

Usage

from pyroutelib3 import Router # Import the router
router = Router("<transport mode>") # Initialise it

start = router.findNode(lat, lon) # Find start and end nodes
end = router.findNode(lat, lon)

status, route = router.doRoute(start, end) # Find the route - a list of OSM nodes

if status == 'success':
    routeLatLons = list(map(router.nodeLatLon, route)) # Get actual route coordinates

Transport Modes: car, cycle, foot, horse, tram, train

Statuses: success, no_route, gave_up

Offline Routing

If you want to use pyroutelib3 offline or on custom .osm file, you just need to add a second argument to Router: Path to the specific osm file.

from pyroutelib3 import Router
router = Router("<transport mode>", "<path-to-.osm-file>")
# Continue on doing like in the example above

Starting from 1.5 pyroutelib3 now accepts other file formats then OSM XML: .osm.gz, .osm.bz2 and .osm.pbf. However, one has to inform pyroutelib3 what kind of file was provided, like so:

from pyroutelib3 import Router
router = Router("<transport mode>", "<path-to-file>", localfileType="<xml/gz/bz2/pbf>")
More info

For more advanced info on using pyroutelib3 (like cusotmizing way costs) take a look at the wiki: https://github.com/MKuranowski/pyroutelib3/wiki.

Changes from pyroutelib2

  • Porting to python3
  • Making pyroutelib a package
  • Custom transport types
  • Handling the access keys
  • Turn restrictions
  • Offline routers (load only local osm file)

License

pyroutelib3 is distributed under GNU GPL v3.

Copyright 2007, Oliver White Modifications: Copyright 2017-2018, Mikolaj Kuranowski - Based on https://github.com/gaulinmp/pyroutelib2

pyroutelib3 is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

pyroutelib3 is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with pyroutelib3. If not, see http://www.gnu.org/licenses/.