Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

A Python wrapper around the HERE APIs

Project description

HerePy

https://img.shields.io/pypi/v/herepy.svg https://img.shields.io/pypi/pyversions/herepy.svg https://readthedocs.org/projects/herepy/badge/?version=latest https://codecov.io/gh/abdullahselek/HerePy/branch/master/graph/badge.svg https://requires.io/github/abdullahselek/HerePy/requirements.svg?branch=master https://dependencyci.com/github/abdullahselek/HerePy/badge
Linux Windows
https://travis-ci.org/abdullahselek/HerePy.svg?branch=master https://ci.appveyor.com/api/projects/status/wlxrx5h8e8xyhvq2?svg=true

Introduction

This library provides a pure Python interface for the HERE API. It works with Python versions from 2.7+ and Python 3.

HERE provides location based services. HERE exposes a rest APIs and this library is intended to make it even easier for Python programmers to use.

Installing

You can install herepy using:

$ pip install herepy

Getting the code

The code is hosted at https://github.com/abdullahselek/HerePy

Check out the latest development version anonymously with:

$ git clone git://github.com/abdullahselek/HerePy.git
$ cd HerePy

To install dependencies, run either:

$ pip install -Ur requirements.testing.txt
$ pip install -Ur requirements.txt

To install the minimal dependencies for production use (i.e., what is installed with pip install herepy) run:

$ pip install -Ur requirements.txt

Running Tests

The test suite can be run against a single Python version which requires pip install pytest and optionally pip install pytest-cov (these are included if you have installed dependencies from requirements.testing.txt)

To run the unit tests with a single Python version:

$ py.test -v

to also run code coverage:

$ py.test --cov=herepy

To run the unit tests against a set of Python versions:

$ tox

Models

The library utilizes models to represent various data structures returned by HERE:

* herepy.GeocoderResponse
* herepy.RoutingResponse
* herepy.GeocoderAutoCompleteResponse
* herepy.PlacesResponse
* herepy.PlacesSuggestionsResponse
* herepy.PlaceCategoriesResponse
* herepy.PublicTransitResponse

GeocoderApi

Is the wrapper for HERE Geoder API, to use this wrapper and all other wrappers you need a AppId and AppCode which you can get from HERE Developer Portal.

Initiation of GeocoderApi:

import herepy

geocoderApi = herepy.GeocoderApi('app_id', 'app_code')

Geocoding given search text:

response = geocoderApi.free_form('200 S Mathilda Sunnyvale CA')

Geocoding given search text with in given boundingbox:

response = geocoderApi.address_with_boundingbox('200 S Mathilda Sunnyvale CA',
                                                [42.3952,-71.1056],
                                                [42.3312,-71.0228])

Geocoding with given address details:

response = geocoderApi.address_with_details(34, 'Barbaros', 'Istanbul', 'Turkey')

Geocoding with given street and city:

response = geocoderApi.street_intersection('Barbaros', 'Istanbul')

RoutingApi

Initiation of GeocoderApi:

import herepy

routingApi = herepy.RoutingApi('app_id', 'app_code')

Calculate route for car:

response = routingApi.car_route([11.0, 12.0],
                                [22.0, 23.0],
                                [herepy.RouteMode.car, herepy.RouteMode.fastest])

Calculate route for pedestrians:

response = routingApi.pedastrian_route([11.0, 12.0],
                                       [22.0, 23.0],
                                       [herepy.RouteMode.pedestrian, herepy.RouteMode.fastest])

Calculate route between three points:

response = routingApi.intermediate_route([11.0, 12.0],
                                         [15.0, 16.0],
                                         [22.0, 23.0],
                                         [herepy.RouteMode.car, herepy.RouteMode.fastest])

Route for public transport:

response = routingApi.public_transport([11.0, 12.0],
                                       [15.0, 16.0],
                                       True,
                                       [herepy.RouteMode.publicTransport, herepy.RouteMode.fastest])

Calculates the fastest car route between two location:

response = routingApi.location_near_motorway([11.0, 12.0],
                                             [22.0, 23.0],
                                             [herepy.RouteMode.car, herepy.RouteMode.fastest])

Calculates the fastest truck route between two location:

response = routingApi.truck_route([11.0, 12.0],
                                  [22.0, 23.0],
                                  [herepy.RouteMode.truck, herepy.RouteMode.fastest])

GeocoderAutoCompleteApi

Initiation of GeocoderAutoCompleteApi:

import herepy

geocoderAutoCompleteApi = herepy.GeocoderAutoCompleteApi('app_id', 'app_code')

Request a list of suggested addresses found within a specified area:

response = geocoderAutoCompleteApi.address_suggestion('High', [51.5035,-0.1616], 100)

Request a list of suggested addresses within a single country:

response = geocoderAutoCompleteApi.limit_results_byaddress('Nis', 'USA')

Request an annotated list of suggested addresses with matching tokens highlighted:

response = geocoderAutoCompleteApi.highlighting_matches('Wacker Chic', '**', '**')

PlacesApi

Initiation of PlacesApi:

import herepy

placesApi = herepy.PlacesApi('app_id', 'app_code')

Request a list of nearby places based on a query string:

response = placesApi.onebox_search([37.7905, -122.4107], 'restaurant')

Request a list of popular places around a location:

response = placesApi.places_at([37.7905, -122.4107])

Request a list of places within a category around a location:

response = placesApi.category_places_at([37.7905, -122.4107], [herepy.PlacesCategory.eat_drink])

Request a list of places close to a location:

response = placesApi.nearby_places([37.7905, -122.4107])

Request a list of suggestions based on a partial query string:

response = placesApi.search_suggestions([52.5159, 13.3777], 'berlin')

Request a list of place categories available for a given location:

response = placesApi.place_categories([52.5159, 13.3777])

Request a list of popular places within a specified area:

response = placesApi.places_at_boundingbox([-122.408, 37.793], [-122.4070, 37.7942])

Request a list of popular places around a location using a foreign language:

response = placesApi.places_with_language([48.8580, 2.2945], 'en-US')

PublicTransitApi

Initiation of PublicTransitApi:

import herepy

publicTransitApi = herepy.PublicTransitApi('app_id', 'app_code')

License

MIT License

Copyright (c) 2017 Abdullah Selek

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
herepy-0.5.0-py2.py3-none-any.whl (19.6 kB) Copy SHA256 hash SHA256 Wheel py2.py3
herepy-0.5.0.tar.gz (16.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page