Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme.md fixes #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Readme.md fixes #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# ValhallaPY

This is a quick python wrapper for the [Valhalla]() service from MapZen
This is a quick python wrapper for the [Valhalla](https://www.mapzen.com/blog/valhalla-intro/) service from MapZen

## Instalation
## Installation

pip install valhallapy

Expand Down Expand Up @@ -30,7 +30,7 @@ from valhalla import Valhalla
valhalla = Valhalla(host="http://192.168.99.100:5333", api_key="")
```

where the api key is optional (get your api keys [here](https://mapzen.com/developers/sign_in) if you are running locally. Once you have a connection, request a route by
where the api key is optional (get your api keys [here](https://mapzen.com/developers/sign_in)) if you are running locally. Once you have a connection, request a route by

## Get a route

Expand All @@ -40,9 +40,9 @@ Request a route using the following
route = valhalla.route(start, end, costing)
```

where costing can be 'pedestrian', 'auto' etc ([full list of costing models](https://mapzen.com/documentation/turn-by-turn/api-reference/#costing-models)).
where costing can be 'pedestrian', 'auto' etc. ([full list of costing models](https://mapzen.com/documentation/turn-by-turn/api-reference/#costing-models)).

This returns a ValhallaRoute object which can be interegated for information about the returned route
This returns a ValhallaRoute object which can be integrated for information about the returned route

```python
route.time() # The time in seconds the route will take
Expand Down