{
    "info": {
        "author": "Route4Me Python Team (SDK)",
        "author_email": "python-team@route4me.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 2 - Pre-Alpha",
            "Environment :: Other Environment",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: ISC License (ISCL)",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.6",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.5",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: Implementation",
            "Programming Language :: Python :: Implementation :: CPython",
            "Programming Language :: Python :: Implementation :: PyPy",
            "Topic :: Software Development :: Libraries :: Python Modules"
        ],
        "description": "======================================\nRoute4Me Route Optimization Python SDK\n======================================\n\nBuild\n\n.. image:: https://travis-ci.org/route4me/route4me-python-sdk.svg?branch=master\n    :target: https://travis-ci.org/route4me/route4me-python-sdk\n.. image:: https://ci.appveyor.com/api/projects/status/f8cplsonrapwlqwg/branch/master?svg=true\n    :target: https://ci.appveyor.com/project/route4me/route4me-python-sdk\n\nPyPI info\n\n.. image:: https://img.shields.io/pypi/pyversions/route4me-sdk.svg\n    :target: PYPI_\n.. image:: https://img.shields.io/pypi/implementation/route4me-sdk.svg\n    :target: PYPI_\n.. image:: https://img.shields.io/pypi/l/route4me-sdk.svg\n    :target: PYPI_\n.. image:: https://img.shields.io/pypi/v/route4me-sdk.svg\n    :target: PYPI_\n.. image:: https://img.shields.io/pypi/dm/route4me-sdk.svg\n    :target: PYPI_\n\nGitHub info\n\n.. https://img.shields.io/github/stars/badges/shields.svg?style=social&label=Star&style=plastic\n\n.. image:: http://githubbadges.com/star.svg?user=route4me&repo=route4me-python-sdk&style=flat\n    :target: GITHUB_\n.. image:: http://githubbadges.com/fork.svg?user=route4me&repo=route4me-python-sdk&style=flat\n    :target: GITHUB_\n\nCode metrics\n\n.. image:: https://codebeat.co/badges/d83fbf08-b87c-470a-b781-5a1815475e00\n    :target: https://codebeat.co/projects/github-com-route4me-route4me-python-sdk\n.. image:: https://scrutinizer-ci.com/g/route4me/route4me-python-sdk/badges/quality-score.png?b=master\n    :target: https://scrutinizer-ci.com/g/route4me/route4me-python-sdk/?branch=master\n.. image:: https://scrutinizer-ci.com/g/route4me/route4me-python-sdk/badges/build.png?b=master\n    :target: https://scrutinizer-ci.com/g/route4me/route4me-python-sdk/build-status/master\n.. image:: https://scrutinizer-ci.com/g/route4me/route4me-python-sdk/badges/coverage.png?b=master\n    :target: https://scrutinizer-ci.com/g/route4me/route4me-python-sdk/?branch=master\n.. image:: https://codecov.io/gh/route4me/route4me-python-sdk/branch/master/graph/badge.svg\n    :target: https://codecov.io/gh/route4me/route4me-python-sdk\n\n\n.. _PYPI: https://pypi.org/project/route4me-sdk/\n.. _GITHUB: https://github.com/route4me/route4me-python-sdk\n\nThe official Python SDK for `Route4Me API <https://route4me.io/docs/>`_\n\n`Documentation on ReadTheDocs <http://route4me-python-sdk.readthedocs.io/>`_\n\n.. image:: https://readthedocs.org/projects/route4me-python-sdk/badge/?version=latest\n    :target: http://route4me-python-sdk.readthedocs.io/?version=latest\n    :alt: Documentation Status\n\n--------------------------------------------------------------------------------\nInstall\n--------------------------------------------------------------------------------\n\n.. code-block:: bash\n\n    $ pip install route4me-sdk\n\n--------------------------------------------------------------------------------\nExample\n--------------------------------------------------------------------------------\n\n.. code-block:: python\n\n    from route4me.sdk import Route4Me\n\n    r4m = Route4Me(api_key='11111111111111111111111111111111')\n    opt = r4m.Optimizations.get('07372F2CF3814EC6DFFAFE92E22771AA')\n\n    print(opt)\n\n\n--------------------------------------------------------------------------------\nFAQ\n--------------------------------------------------------------------------------\n\n********************************************************************************\nWhat does the Route4Me SDK permit me to do?\n********************************************************************************\n\nThis SDK makes it easier for you use the Route4Me API, which creates optimally sequenced driving routes for many drivers.\n\n********************************************************************************\nWho can use the Route4Me SDK (and API)?\n********************************************************************************\n\nThe service is typically used by organizations who must route many drivers to many destinations. In addition to route optimization for new (future) routes, the API can also be used to analyze historical routes and to distribute routes to field personnel.\n\n********************************************************************************\nWho is prohibited from using the Route4Me SDK (and API)?\n********************************************************************************\n\nThe Route4Me SDK and API cannot be resold or used in a product or system that competes directly with Route4Me. This means that developers cannot resell route optimization services to other businesses or developers. However, developers can integrate our route optimization SDK/API into their software applications. Developers and startups are also permitted to use our software for internal purposes (i.e. the same day delivery startup).\n\n\n********************************************************************************\nHow does the API/SDK Integration Work?\n********************************************************************************\n\nA Route4Me customer, integrator, or partner incorporates the Route4Me SDK or API into their code base.\nRoute4Me permits any paying subscriber to interact with every part of its system using its API.\nThe API is RESTful, which means that it\u2019s web based and can be accessed by other programs and machines\nThe API/SDK should be used to automate the route planning process or to generate many routes with minimal manual intervention\n\n********************************************************************************\nDo optimized routes automatically appear inside my Route4Me account?\n********************************************************************************\n\nEvery Route4Me SDK instance needs a unique API key. The API key can be retrieved inside your Route4Me.com account, inside the Settings tab called API. When a route is planned, it appears inside the corresponding Route4Me account. Because Route4Me web and mobile accounts are synchronized, the routes will appear in both environments at the same time.\n\n********************************************************************************\nCan I test the SDK with other addresses without a valid API Key?\n********************************************************************************\n\nNo. The sample API key only permits you to optimize routes with the sample address coordinates that are part of this SDK.\n\n********************************************************************************\nDoes the SDK have rate limits?\n********************************************************************************\n\nThe number of requests you can make per second is limited by your current subscription plan. Typically, there are different rate limits for these core features:\nAddress Geocoding & Address Reverse Geocoding\nRoute Optimization & Management\nViewing a Route\n\n********************************************************************************\nWhat is the recommended architecture for the Route4Me SDK?\n********************************************************************************\n\nThere are two typical integration strategies that we recommend.  Using this SDK, you can make optimization requests and then the SDK polls the Route4Me API to detect state changes as the optimization progresses. Alternatively, you can provide a webhook/callback URL, and the API will notify that callback URL every time there is a state change.\n\n***************************************************************************************************************************\nI don't need route management or mobile capabilities. Is there a lower level Route4Me API just for the optimization engine?\n***************************************************************************************************************************\n\nYes. Please contact support@route4me.com to learn about the low-level RESTful API.\n\n********************************************************************************\nHow fast is the route Route4Me Optimization Web Service?\n********************************************************************************\n\nMost routes having less than 200 destinations are optimized in 1 second or less.\n\n********************************************************************************\nCan I disable optimization when planning routes?\n********************************************************************************\n\nYes. You can send routes with optimization disabled if you want to conveniently see them on a map, or distribute them to your drivers in the order you prefer.\n\n********************************************************************************\nCan the API be used for aerial vehicles such as drones or self-driving cars?\n********************************************************************************\n\nYes. The API can accept latitude/longitude and an unlimited amount of per-address metadata. The metadata will be preserved as passthrough data by our API so that the receiving device will have access to critical data when our API invokes a webhook callback to the device.\n\n********************************************************************************\nAre all my optimized routes stored permanently stored in the Route4Me database?\n********************************************************************************\n\nYes. All routes are permanently stored in the database and are no longer accessible to you after your subscription is terminated.\n\n\n********************************************************************************\nCan I incorporate your API into my mobile application?\n********************************************************************************\n\nRoute4Me\u2019s route planning and optimization technology can only be added into applications that do not directly compete with Route4Me.\nThis means the application\u2019s primary capabilities must be unrelated to route optimization, route planning, or navigation.\n\n********************************************************************************\nCan I pay you to develop a custom algorithm?\n********************************************************************************\n\nYes\n\n********************************************************************************\nCan I use your API and resell it to my customers?\n********************************************************************************\n\nWhite-labeling and private-labeling Route4Me is possible but the deal\u2019s licensing terms vary considerably based on customer count, route count, and the level of support that Route4Me should provide to your customers.\n\n********************************************************************************\nDoes the API/SDK have TMS or EDI, or EDI translator capabilities?\n********************************************************************************\n\nRoute4Me is currently working on these features but they are not currently available for sale.\n\n**********************************************************************************************************\nCan the API/SDK send notifications back to our system using callbacks, notifications, pushes, or webhooks?\n**********************************************************************************************************\n\nBecause Route4Me processes all routes asynchronously, Route4Me will conveniently notify the endpoint you specify as the route optimization job progresses through each state of the optimization. Every stage of the route optimization process has a unique stage id.\n\n********************************************************************************\nDoes the Route4Me API and SDK work in my country?\n********************************************************************************\n\nRoute4Me.com, as well as all of Route4Me\u2019s mobile applications,  use the Route4Me SDK\u2019s and API.\nSince Route4Me works globally, this means that all of Route4Me\u2019s capabilities are available using the SDK\u2019s in every country\n\n\n********************************************************************************\nWill the Route4Me API/SDK work in my program on the Mac, PC, or Linux?\n********************************************************************************\n\nCustomers are encouraged to select their preferred operating system environment. The Route4Me API/SDK will function on any operating system that supports the preferred programming language of the customer. At this point in time, almost every supported SDK can run on any operating system.\n\n\n********************************************************************************\nDoes the Route4Me API/SDK require me to buy my own servers?\n********************************************************************************\n\nRoute4Me has its own computing infrastructure that you can access using the API and SDKs. Customers typically have to run the SDK code on their own computers and/or servers to access this infrastructure.\n\n********************************************************************************\nDoes Route4Me have an on-premise solution?\n********************************************************************************\n\nRoute4Me does not currently lease or sell servers and does not have on-premise appliance solution. This would only be possible in exceptionally unique scenarios.\n\n\n********************************************************************************\nDoes the Route4Me API/SDK require me to have my own programmers?\n********************************************************************************\n\nThe time required to integrate the SDK can be as little as 1 hour or may take several weeks, depending on the number of features being incorporated into the customer\u2019s application and how much integration testing will be done by the client. A programmer\u2019s involvement is almost always required to use Route4Me\u2019s technology when accessing it through the API.",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/route4me/route4me-python-sdk",
        "keywords": "route4me,python,sdk,api",
        "license": "ISC",
        "maintainer": "",
        "maintainer_email": "",
        "name": "route4me-sdk",
        "package_url": "https://pypi.org/project/route4me-sdk/",
        "platform": "any",
        "project_url": "https://pypi.org/project/route4me-sdk/",
        "project_urls": {
            "Homepage": "https://github.com/route4me/route4me-python-sdk"
        },
        "release_url": "https://pypi.org/project/route4me-sdk/0.1.0.dev8/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Route4Me Python SDK",
        "version": "0.1.0.dev8"
    },
    "last_serial": 3121569,
    "releases": {
        "0.1.0.dev0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2bc9f1233db3a45822abf714b0b9ee8d",
                    "sha256": "fae4ed6a0aabd079d7cddc280c0cbbbe5a7d9f83539c95ca65d12357d5866c99"
                },
                "downloads": -1,
                "filename": "route4me-sdk-0.1.0.dev0.tar.gz",
                "has_sig": false,
                "md5_digest": "2bc9f1233db3a45822abf714b0b9ee8d",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13371,
                "upload_time": "2017-08-13T10:22:59",
                "url": "https://files.pythonhosted.org/packages/0a/49/01a5393e6708e367292675de9ebee420f0eea80a855e2b94af5959383607/route4me-sdk-0.1.0.dev0.tar.gz"
            }
        ],
        "0.1.0.dev1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "4217cbf9bea3b95806e0b987732a7cfd",
                    "sha256": "d0009d25d1578100a50a3d442ecdf1956492eb50973cf2029ce9896162e56320"
                },
                "downloads": -1,
                "filename": "route4me-sdk-0.1.0.dev1.tar.gz",
                "has_sig": false,
                "md5_digest": "4217cbf9bea3b95806e0b987732a7cfd",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 11859,
                "upload_time": "2017-08-13T10:36:36",
                "url": "https://files.pythonhosted.org/packages/0f/d6/956cb6320f5756d8f309eb9cf57d6ae5819031bebf39e9c2d92c11c3ce8a/route4me-sdk-0.1.0.dev1.tar.gz"
            }
        ],
        "0.1.0.dev2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "44726c11fef06d8c800e3d8e01913c66",
                    "sha256": "cffd988e9ef65d35079f88ded0e5981b5adb66523d75864b9ccdebf90887005f"
                },
                "downloads": -1,
                "filename": "route4me-sdk-0.1.0.dev2.tar.gz",
                "has_sig": false,
                "md5_digest": "44726c11fef06d8c800e3d8e01913c66",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13514,
                "upload_time": "2017-08-13T10:53:12",
                "url": "https://files.pythonhosted.org/packages/3f/bc/fdd3bed86d951d507ffe164ec2d997dbb999b76e85b683a0c42c7d1b7a09/route4me-sdk-0.1.0.dev2.tar.gz"
            }
        ],
        "0.1.0.dev3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "ad6a981462550d0513e007711650ddb6",
                    "sha256": "626cdbfd1768dc26029d95dc131489bdd392de388e0310b30738bbf0b9af8510"
                },
                "downloads": -1,
                "filename": "route4me-sdk-0.1.0.dev3.tar.gz",
                "has_sig": false,
                "md5_digest": "ad6a981462550d0513e007711650ddb6",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13006,
                "upload_time": "2017-08-13T11:16:51",
                "url": "https://files.pythonhosted.org/packages/eb/04/d101ded0976a0a951944a04c08fea688d79c98526a8a55c4bfa492605f8c/route4me-sdk-0.1.0.dev3.tar.gz"
            }
        ],
        "0.1.0.dev4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9897e0f72e9eb1bdd5f41d0085540cf1",
                    "sha256": "563b59ec1b30f845e4b537e2807e1afb25ec240659ea4b87f3cf278ca94edf51"
                },
                "downloads": -1,
                "filename": "route4me_sdk-0.1.0.dev4-py3.5.egg",
                "has_sig": false,
                "md5_digest": "9897e0f72e9eb1bdd5f41d0085540cf1",
                "packagetype": "bdist_egg",
                "python_version": "3.5",
                "requires_python": null,
                "size": 45126,
                "upload_time": "2017-08-13T11:41:19",
                "url": "https://files.pythonhosted.org/packages/db/d2/78d1a714867726b2180e5cf5058713c0f83d8d7c7dd7a96023e47997c3d3/route4me_sdk-0.1.0.dev4-py3.5.egg"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "45c8609d4409552b6fc41a42cea01d40",
                    "sha256": "14be04630135196ae4fa6dd5f0b7708e2f707515665104568cab0ee13346c7cf"
                },
                "downloads": -1,
                "filename": "route4me-sdk-0.1.0.dev4.tar.gz",
                "has_sig": false,
                "md5_digest": "45c8609d4409552b6fc41a42cea01d40",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 13056,
                "upload_time": "2017-08-13T11:41:18",
                "url": "https://files.pythonhosted.org/packages/b6/36/1d48ebda05e214764d20f30f0daca2423b125666c4dcc1962681ecff3c1f/route4me-sdk-0.1.0.dev4.tar.gz"
            }
        ],
        "0.1.0.dev6": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "42075b00b659338485f1cd8842f20827",
                    "sha256": "98c473de2c8fede73faeac6ea8339f16fd11c1cdf1f7df975ec6600aa4622b15"
                },
                "downloads": -1,
                "filename": "route4me-sdk-0.1.0.dev6.tar.gz",
                "has_sig": false,
                "md5_digest": "42075b00b659338485f1cd8842f20827",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16644,
                "upload_time": "2017-08-24T01:18:40",
                "url": "https://files.pythonhosted.org/packages/6f/c4/9c0bac720d6d2f9c349f13c9171658240c9a6ceefa3eb73dad56e082e988/route4me-sdk-0.1.0.dev6.tar.gz"
            }
        ],
        "0.1.0.dev7": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "c61e0501bbdda037ac19be4fc58a093a",
                    "sha256": "a83803658a6f856dfd6370e62fa5ee7470ff4207abfc10c9cf9f3ebde6e3ca64"
                },
                "downloads": -1,
                "filename": "route4me-sdk-0.1.0.dev7.tar.gz",
                "has_sig": false,
                "md5_digest": "c61e0501bbdda037ac19be4fc58a093a",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16719,
                "upload_time": "2017-08-24T01:22:46",
                "url": "https://files.pythonhosted.org/packages/18/a0/9c6eaae66040a8e5edcadc978977ca41a3710a797357d9ba91dcb242f191/route4me-sdk-0.1.0.dev7.tar.gz"
            }
        ],
        "0.1.0.dev8": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "15a2898848a570da5226457eb8a2ed0e",
                    "sha256": "8070faf9ada7660ee1c30ae3f393ec3f3342ccd9683410428b287d34172a07da"
                },
                "downloads": -1,
                "filename": "route4me-sdk-0.1.0.dev8.tar.gz",
                "has_sig": false,
                "md5_digest": "15a2898848a570da5226457eb8a2ed0e",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17910,
                "upload_time": "2017-08-24T20:59:22",
                "url": "https://files.pythonhosted.org/packages/ae/82/5ca43a96c187410d599991a99c6b04c6e34f77063639e82c6d7fa36cec26/route4me-sdk-0.1.0.dev8.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "15a2898848a570da5226457eb8a2ed0e",
                "sha256": "8070faf9ada7660ee1c30ae3f393ec3f3342ccd9683410428b287d34172a07da"
            },
            "downloads": -1,
            "filename": "route4me-sdk-0.1.0.dev8.tar.gz",
            "has_sig": false,
            "md5_digest": "15a2898848a570da5226457eb8a2ed0e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 17910,
            "upload_time": "2017-08-24T20:59:22",
            "url": "https://files.pythonhosted.org/packages/ae/82/5ca43a96c187410d599991a99c6b04c6e34f77063639e82c6d7fa36cec26/route4me-sdk-0.1.0.dev8.tar.gz"
        }
    ]
}