# -*- coding: utf-8 -*-
"""
Official Python SDK for Route4Me
Consists of classes:
- access to all Route4Me API's endpoints;
- convenient models for Route4Me's entities;
- constants and enums;
Look out the appropriate section for details.
"""
import logging
from .endpoints.geocodings import Geocodings
from .endpoints.members import Members
from .endpoints.optimizations import Optimizations
from .endpoints.telematics import Telematics
from .version import PROJECT
from .version import COPYRIGHT
from .version import AUTHOR
from .version import TITLE
from .version import LICENSE
from .version import VERSION_STRING
from .version import RELEASE_STRING
from .version import BUILD
from .version import COMMIT
from route4me.sdk._internals.net import NetworkClient
log = logging.getLogger(__name__)
__project__ = PROJECT
__copyright__ = COPYRIGHT
__author__ = AUTHOR
__title__ = TITLE
__license__ = LICENSE
__version__ = VERSION_STRING
__release__ = RELEASE_STRING
__build__ = BUILD
__commit__ = COMMIT
__all__ = [
'ApiClient',
]
[docs]class ApiClient(object):
"""
Route4Me API client
Provides an access to API's endpoints through a convenient interface. In
other words, all the power of Route4Me API is accessible through this
class.
"""
version = __version__
[docs] def __init__(self, api_key=None):
log.info(
'Init Route4Me Python SDK [%s] build [%s] commit [%s]',
self.version,
__build__,
__commit__,
)
nc = NetworkClient(api_key=api_key)
resource_params = {
'api_key': api_key,
'_network_client': nc,
}
self.activity_feed = {} # noqa: E221 # TODO: implement
self.addresses = {} # noqa: E221 # TODO: implement
self.address_book = {} # noqa: E221 # TODO: implement
self.avoidance_zones = {} # noqa: E221 # TODO: implement
self._geocodings = Geocodings(**resource_params)
self._members = Members(**resource_params)
self.notes = {} # noqa: E221 # TODO: implement
self._optimizations = Optimizations(**resource_params)
self.orders = {} # noqa: E221 # TODO: implement
self.routes = {} # noqa: E221 # TODO: implement
self._telematics = Telematics(**resource_params)
self.territories = {} # noqa: E221 # TODO: implement
self.tracking = {} # noqa: E221 # TODO: implement
self.vehicles = {} # noqa: E221 # TODO: implement
@property
def geocodings(self):
"""
Geocodings endpoint functions
:returns: Geocoding namespace
:rtype: :class:`~endpoints.geocodings.Geocodings`
"""
return self._geocodings
@property
def members(self):
return self._members
@property
def optimizations(self):
"""
Optimization endpoint functions
:returns: Optimization namespace
:rtype: :class:`~endpoints.optimizations.Optimizations`
"""
return self._optimizations
@property
def telematics(self):
return self._telematics