neshan 1.0.1

Python client library for Neshan maps

Python Client for Google Maps Services

Description

This library is a duplication of https://github.com/googlemaps/google-maps-services-python which is changed to work with Neshan APIs. Please open an issue if you have any questions.

The Python Client for Neshan Services is a Python Client library for the following Neshan APIs:

• Directions API
• Distance Matrix API
• Reverse Geocoding API
• Map Matching API
• Search API

Requirements

• Python 3.5 or later.
• A Neshan API key.

Installation

$ pip install -U neshan

Note that you will need requests 2.4.0 or higher if you want to specify connect/read timeouts.

Usage

This example uses the Geocoding API and the Directions API with an API key:

import neshan
from datetime import datetime

nmaps = neshan.Client(key='Add Your Key here')

# Look up an address with reverse geocoding
reverse_geocode_result = nmaps.reverse_geocode((40.714224, -73.961452))

# Request directions via public transit
now = datetime.now()
directions_result = nmaps.direction((36.268706, 59.610011),
                                    (36.287607, 59.599527),
                                    departure_time=now)

Features

Retry on Failure

Automatically retry when intermittent failures occur. That is, when any of the retriable 5xx errors are returned from the API.

Building the Project

# Installing nox
$ pip install nox

# Running tests
$ nox

# Generating documentation
$ nox -e docs

# Copy docs to gh-pages
$ nox -e docs && mv docs/_build/html generated_docs && git clean -Xdi && git checkout gh-pages

Documentation & resources

API docs

• Get Started with Neshan Platform
• Directions API
• Distance Matrix API
• Reverse Geocoding API
• Map Matching API
• Search API

Support

• Report an issue
• Contribute

Changelog

All notable changes to this project will be documented in this file.

[v1.0.0]

Added

• Initial version