{
    "info": {
        "author": "Dan Loewenherz",
        "author_email": "dan@lionheartsw.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: Apache Software License",
            "Natural Language :: English",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Topic :: Internet :: WWW/HTTP :: Dynamic Content :: CGI Tools/Libraries",
            "Topic :: Software Development :: Libraries :: Python Modules",
            "Topic :: Utilities"
        ],
        "description": "Python-Onfleet\n==============\n\n|ci|_ \u2003 |version|_ \u2003 |downloads|_\n\n.. |ci| image:: https://img.shields.io/travis/lionheart/python-onfleet.svg?style=flat\n.. _ci: https://travis-ci.org/lionheart/onfleet.py\n\n.. |downloads| image:: https://img.shields.io/pypi/dm/onfleet.svg?style=flat\n.. _downloads: https://pypi.python.org/pypi/onfleet\n\n.. |version| image:: https://img.shields.io/pypi/v/onfleet.svg?style=flat\n.. _version: https://pypi.python.org/pypi/onfleet\n\npython-onfleet is an easy-to-use and fully-functional Python wrapper for the `Onfleet API <http://docs.onfleet.com/v2.0/>`_.\n\nInstallation\n------------\n\npython-onfleet is available for download through the Python Package Index (PyPi). You can install it right away using pip or easy_install.\n\n.. code:: bash\n\n   pip install onfleet\n\nNo dependencies (besides Python >= 2.7).\n\nUsage\n-----\n\nTo get started, you're going to need to get an Onfleet account set up and create an API token. Once you've got that, you're ready to go.\n\n.. code:: pycon\n\n   >>> import onfleet\n   >>> on = onfleet.Onfleet(api_token)\n\nOnce you've done this, you can now use the `on` object to make calls to the Onfleet API. Here are some examples:\n\nOrganizations\n'''''''''''''\n\n.. code:: pycon\n\n   >>> organization = on.organization()\n   >>> organization\n   <Organization id='O1o6D8OryDMILx2YEW3YOFFg'>\n   >>> organization.created_on\n   1425052175000\n\n\nAdministrators\n''''''''''''''\n\nCreate a new administrator:\n\n.. code:: pycon\n\n   >>> administrator = onfleet.Administrator(name=\"John Doe\", email=\"john@example.com\")\n   >>> on.admins(administrator, method=\"POST\")\n   <Administrator id='lMmclZVdpCqzpN9~tSzvIjHn'>\n\nList all administrators:\n\n.. code:: pycon\n\n   >>> on.admins()\n   [<Administrator id='lMmclZVdpCqzpN9~tSzvIjHn'>,\n    <Administrator id='IP4mhhsuA*RivOvpJG9y~tI7'>]\n   >>> admins = _\n   >>> admins[0].name\n   John Doe\n\nWorkers\n'''''''\n\nList workers:\n\n.. code:: pycon\n\n   >>> on.workers()\n   <Worker name='John D'>, <Worker name='Sally D'>]\n\nCreate a new worker:\n\n.. code:: pycon\n\n   >>> vehicle = onfleet.Vehicle(vehicle_type=onfleet.Vehicle.CAR, description=\"2010 Jetta\", licensePlate=\"123456\", color=\"White\")\n   >>> worker = onfleet.Worker(name=\"John Smith\", phone=\"1234567890\", vehicle=vehicle)\n   >>> on.worker(worker, method=\"POST\")\n\nGet a single worker:\n\n.. code:: pycon\n\n   >>> onfleet.Worker[worker_id]()\n   <Worker name='John D'>\n\nUpdate a worker:\n\n.. code:: pycon\n\n   >>> worker = onfleet.Worker(id=\"12345\", tasks=[\"1234\"])\n   >>> on.worker(worker, method=\"PUT\")\n\nTeams\n'''''\n\nList teams:\n\n.. code:: pycon\n\n   >>> on.teams()\n   [{u'id': u'n3MMWj0Cq6emWBg1v0ugJ46f',\n     u'managers': [u'BKH3rtJxU*XdH6anWsn1YEsU'],\n     u'name': u'Test Team',\n     u'timeCreated': 1427748462000,\n     u'timeLastModified': 1427905261933,\n     u'workers': [u'i0TlEqfEk8E65a4dW~0J58VZ', u'SKmm09tPTCLkEWnGKW1AsLh9']}]\n\nGet a single team:\n\n.. code:: pycon\n\n   >>> on.teams['n3MMWj0Cq6emWBg1v0ugJ46f']()\n   {u'id': u'n3MMWj0Cq6emWBF1a0ugJ46f',\n    u'managers': [],\n    u'name': u'Test Team',\n    u'timeCreated': 1427748462000,\n    u'timeLastModified': 1427905261933,\n    u'workers': [{u'id': u'i0TlEqfak8E65i4dW~0J58VZ',\n      u'name': u'John D',\n      u'phone': u'+17172372831'},\n     {u'id': u'SKmm09j3jJJKHanGKW1AsLW9',\n      u'name': u'Sally R',\n      u'phone': u'+15023838282'}]}\n\nDestinations\n''''''''''''\n\nCreate a new destination:\n\n.. code:: pycon\n\n   >>> destination = on.destinations(Destination(address=Address(unparsed=\"543 Howard Street, San Francisco, CA 94105\")), method=\"POST\")\n   >>> destination\n   <Destination id='RJ6SnbJntnGx3M72QvDnWDhn'>\n   >>> destination.location\n   [-122.3965731, 37.7875728]\n\n\nGet a single destination:\n\n.. code:: pycon\n\n   >>> on.destinations['RJ6SnbJntnGx3M72QvDnWDhn']()\n   <Destination id='RJ6SnbJntnGx3M72QvDnWDhn'>\n\n\nTasks\n'''''\n\nTODO\n\nRecipients\n''''''''''\n\nTODO\n\nMiscellaneous\n'''''''''''''\n\nBy default, python-onfleet will return parsed JSON objects. If you'd like the raw response object for a request, just pass in `parse_response=False`.\n\n.. code:: pycon\n\n   >>> response = on.organization(parse_response=False)\n   ... your org ...\n\n\nPython-onfleet maps 1-1 to the Onfleet API (e.g., pb.one.two.three['1234']() will send a request to \"https://api.onfleet.com/api/v2/one/two/three/1234\"). For more information on other methods and usage, please read the `Onfleet API documentation <http://docs.onfleet.com/v2.0/docs>`_.\n\nSupport\n-------\n\nIf you like this library, or need help implementing it, send us an email: hi@lionheartsw.com.\n\nLicense\n-------\n\n.. image:: http://img.shields.io/pypi/l/onfleet.svg?style=flat\n   :target: https://github.com/lionheart/python-onfleet/blob/master/LICENSE\n\nApache License, Version 2.0. See `LICENSE <https://github.com/lionheart/python-onfleet/blob/master/LICENSE>`_ for details.\n\n",
        "description_content_type": null,
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "http://github.com/lionheart/python-onfleet",
        "keywords": "onfleet",
        "license": "Apache 2.0",
        "maintainer": "",
        "maintainer_email": "",
        "name": "onfleet",
        "package_url": "https://pypi.org/project/onfleet/",
        "platform": "",
        "project_url": "https://pypi.org/project/onfleet/",
        "project_urls": {
            "Homepage": "http://github.com/lionheart/python-onfleet"
        },
        "release_url": "https://pypi.org/project/onfleet/1.0.0/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "A Python wrapper for Onfleet",
        "version": "1.0.0"
    },
    "last_serial": 2401767,
    "releases": {
        "0.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8b98da02eca71800eb42bb6cbc8b28bf",
                    "sha256": "9459a2e1ab2965ad6d092d9b85c4f76d50dfba5bbeeb57086cd8acc9f44f696d"
                },
                "downloads": -1,
                "filename": "onfleet-0.0.1.tar.gz",
                "has_sig": true,
                "md5_digest": "8b98da02eca71800eb42bb6cbc8b28bf",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 6881,
                "upload_time": "2015-04-06T19:22:06",
                "url": "https://files.pythonhosted.org/packages/ec/b0/8f054c1ab551c173e24d1c861478614f56c785968357444a9d1e6010983f/onfleet-0.0.1.tar.gz"
            }
        ],
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "55212faaa98145f880b0d0281925a471",
                    "sha256": "8345c79dcf812e55e686f2d026aeb6bf45c67ef6f73d67048605c2b577c33daa"
                },
                "downloads": -1,
                "filename": "onfleet-1.0.0.tar.gz",
                "has_sig": true,
                "md5_digest": "55212faaa98145f880b0d0281925a471",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 7561,
                "upload_time": "2016-10-15T23:50:15",
                "url": "https://files.pythonhosted.org/packages/1f/de/7a185cf3d57b696d9ba2649ee061a16727648dce7cf6fbf25e638525606f/onfleet-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "55212faaa98145f880b0d0281925a471",
                "sha256": "8345c79dcf812e55e686f2d026aeb6bf45c67ef6f73d67048605c2b577c33daa"
            },
            "downloads": -1,
            "filename": "onfleet-1.0.0.tar.gz",
            "has_sig": true,
            "md5_digest": "55212faaa98145f880b0d0281925a471",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 7561,
            "upload_time": "2016-10-15T23:50:15",
            "url": "https://files.pythonhosted.org/packages/1f/de/7a185cf3d57b696d9ba2649ee061a16727648dce7cf6fbf25e638525606f/onfleet-1.0.0.tar.gz"
        }
    ]
}