WaypointOptions do not apply to all `via` waypoints

(DEPRECATED) HERE Location Services for Python

Note: This library depends on HERE HLS Legacy, which will be deactivated on Dec 31st 2023. See here for more information.

A Python client for HERE Location Services.

Usage

Geocoding using HERE Geocoding & Search API.

Isolines using HERE Isoline Routing API.

Prerequisites

Before you can install HERE Location Services for Python, run its test-suite, or use the example notebooks to make sure you meet the following prerequisites:

A Python installation, 3.6+ recommended, with the pip command available to install dependencies.
In order to use Location services APIs, authentication is required. There are two ways to authenticate:
- Authentication using an API key:
  - For API key-based authentication you will need a HERE developer account, freely available under HERE Developer Portal.
  - An API key from the HERE Developer Portal, in an environment variable named LS_API_KEY which you can set like this (with a valid value, of course):
```
$ export LS_API_KEY="MY-LS-API-KEY"
```
- OAuth token-based authentication:
  - For OAuth token authentication you will need an account on the HERE Platform. To get more details on the HERE Platform account please check our documentation Get a HERE account. Once you have the account follow the below steps to get credentials:
  - Go to HERE Platform Applications and Keys and register a new app.
  - Create a key for the app and download the generated credentials. properties file.
  The HERE platform generated app credentials should look similar to the example below:
```
here.user.id = <example_here>
here.client.id = <example_here>
here.access.key.id = <example_here>
here.access.key.secret = <example_here>
here.token.endpoint.url = <example_here>
```
  You can provide your credentials using any of the following methods:
  - Default credentials
  - Environment variables
  - Credentials file
  Default credentials
  
  Place the credentials file into
  
  For Linux/MacOS: $HOME/.here/credentials.properties
  
  For Windows: %USERPROFILE%\.here\credentials.properties Code snippet to instantiate LS object:
```
from here_location_services import LS

# platform credentials will be picked from the default credentials file's location mentioned above
# and api_key should not be set in env variable LS_API_KEY.
ls = LS()
```
  Environment Variables
  
  You can override default credentials by assigning values to the following environment variables:
```
HERE_USER_ID
HERE_CLIENT_ID
HERE_ACCESS_KEY_ID
HERE_ACCESS_KEY_SECRET
HERE_TOKEN_ENDPOINT_URL
```
  Code snippet to instantiate LS object:
```
from here_location_services import LS
from here_location_services import PlatformCredentials

ls = LS(platform_credentials=PlatformCredentials.from_env()) 
```
  Credentials File
  
  You can specify any credentials file as an alternative to that found in ~/.here/credentials.properties. An error is generated if there is no file present at the path, or if the file is not properly formatted. Code snippet to instantiate LS object:
```
from here_location_services import LS
from here_location_services import PlatformCredentials

platform_credentials = PlatformCredentials.from_credentials_file("<Path_to_file>")
ls = LS(platform_credentials=platform_credentials) 
```

Installation

Install HERE Location Services for Python with conda from the Anaconda conda-forge channel using the below command:
```
$ conda install -c conda-forge here-location-services
```
Install HERE Location Services for Python from PyPI using the below command:
```
$ pip install here-location-services
```

Install HERE Location Services for Python from GitHub using the below command:

$ pip install -e git+https://github.com/heremaps/here-location-services-python#egg=here-location-services

Run Test Suite

Run the test suite using below commands:

$ pip install -r requirements_dev.txt
$ pytest -v --cov=here_location_services tests

Documentation

Documentation is available here.

Run the below commands to build the docs locally:

$ pip install -e .
$ pip install -r requirements_dev.txt
$ sh scripts/build_docs.sh

Hello World Example

The following are tiny "Hello World" like examples that you can run to have a successful first HERE Location Services experience right after installation!

Using API key

import json
import os

from here_location_services import LS


LS_API_KEY = os.environ.get("LS_API_KEY")  # Get API KEY from environment.
ls = LS(api_key=LS_API_KEY)

address = "Invalidenstr 116, 10115 Berlin, Germany"
geo = ls.geocode(query=address)
print(json.dumps(geo.to_geojson(), indent=2, sort_keys=True))

Using OAuth token

import json

from here_location_services import LS
from here_location_services import PlatformCredentials

credentials = PlatformCredentials.from_default()
ls = LS(platform_credentials=credentials)

address = "Invalidenstr 116, 10115 Berlin, Germany"
geo = ls.geocode(query=address)
print(json.dumps(geo.to_geojson(), indent=2, sort_keys=True))

License

See the License file at the root of this project for license details.

	if via:
	lat, lng = via[0]
	via_str = f"?via={lat},{lng}"
	if len(via) > 1:
	vias = "&".join("via=" + str(item[0]) + "," + str(item[1]) for item in via[1:])
	via_str = via_str + "&" + vias
	if via_place_options:
	via_place_opt = ";".join(
	key + "=" + str(val)
	for key, val in vars(via_place_options).items()
	if val is not None
	)
	via_str = via_str + ";" + via_place_opt
	if via_waypoint_options:
	via_way_opt = "!".join(
	key + "=" + str(val)
	for key, val in vars(via_waypoint_options).items()
	if val is not None
	)
	via_str = via_str + "!" + via_way_opt
	url += via_str

	class MatrixRoutingResponse(ApiResponse):
	"""A class representing Matrix routing response data."""

	def __init__(self, **kwargs):
	super().__init__()
	self._filters = {"matrix": None}
	for param, default in self._filters.items():
	setattr(self, param, kwargs.get(param, default))

	def to_geojson(self):
	"""Return API response as GeoJSON."""
	raise NotImplementedError("This method is not valid for MatrixRoutingResponse.")

	def to_distnaces_matrix(self):
	"""Return distnaces matrix in a dataframe."""
	if self.matrix and self.matrix.get("distances"):
	distances = self.matrix.get("distances")
	dest_count = self.matrix.get("numDestinations")
	nested_distances = [
	distances[i : i + dest_count] for i in range(0, len(distances), dest_count)
	]
	return DataFrame(nested_distances, columns=range(dest_count))

	def to_travel_times_matrix(self):
	"""Return travel times matrix in a dataframe."""
	if self.matrix and self.matrix.get("travelTimes"):
	distances = self.matrix.get("travelTimes")
	dest_count = self.matrix.get("numDestinations")
	nested_distances = [
	distances[i : i + dest_count] for i in range(0, len(distances), dest_count)
	]
	return DataFrame(nested_distances, columns=range(dest_count))

package	size	only required for pandas?
pandas	58M	yes
numpy.libs	35M	yes
numpy	33M	yes
pytz	2.8M	yes
oauthlib	1.4M
urllib3	872K
dateutil	748K	yes
idna	496K
here_location_services	484K
8 others	1.5M

heremaps / here-location-services-python Goto Github PK

here-location-services-python's Introduction

(DEPRECATED) HERE Location Services for Python

Note: This library depends on HERE HLS Legacy, which will be deactivated on Dec 31st 2023. See here for more information.

Usage

Prerequisites

Default credentials

Environment Variables

Credentials File

Installation

Run Test Suite

Documentation

Hello World Example

Using API key

Using OAuth token

License

here-location-services-python's People

Contributors

Stargazers

Watchers

Forkers

here-location-services-python's Issues

Issue

Potential alternatives

Context

Package size details

Recommend Projects

Recommend Topics

Recommend Org