vrt-lss-routing

vrt_lss_routing

Description

VRt.Routing is designed to find a route between locations and build time-distance matrices.

Features

• Getting the distance and time between two locations, including traffic jams
• Finding a route between specified locations
• Creating a time-distance matrix

Entity relationship diagram

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 7.22.2904
• Package version: 7.22.2904
• Generator version: 7.15.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import vrt_lss_routing

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import vrt_lss_routing

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import vrt_lss_routing
from vrt_lss_routing.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.edge7.veeroute.cloud
# See configuration.py for a list of all supported configuration parameters.
configuration = vrt_lss_routing.Configuration(
    host = "https://api.edge7.veeroute.cloud"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (JWT): ApiKeyAuth
configuration = vrt_lss_routing.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with vrt_lss_routing.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = vrt_lss_routing.MatrixApi(api_client)
    matrix_task = vrt_lss_routing.MatrixTask() # MatrixTask | New request for matrix calculation.

    try:
        # Time-distance matrix
        api_response = api_instance.run_matrix_calculation(matrix_task)
        print("The response of MatrixApi->run_matrix_calculation:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling MatrixApi->run_matrix_calculation: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.edge7.veeroute.cloud

Class	Method	HTTP request	Description
MatrixApi	run_matrix_calculation	POST /routing/matrix/calculation	Time-distance matrix
RouteApi	run_route_calculation	POST /routing/route/calculation	Route between points
SystemApi	check	GET /routing/system/check	Checking the availability
SystemApi	file	GET /routing/file/{filename}	Getting the documentation
SystemApi	version	GET /routing/system/version	Getting the service version

Documentation For Models

• Attribute
• CheckResult
• General400
• General402
• General404
• General404Detail
• General429
• General500
• GeoSettings
• Geopoint
• MatrixResult
• MatrixTask
• Route
• RouteLeg
• RouteResult
• RouteStatistics
• RouteStep
• RouteTask
• RouteWaypoint
• RoutingMatrix
• RoutingMatrixWaypoint
• SchemaError
• Service
• TimeWindow
• Tracedata
• Trackpoint
• TransportType
• VersionResult

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: Bearer authentication (JWT)

Author

[e-mail]