Skip to main content

Foxtrot Client Library

Project description

This is the Python client library for interacting with the Foxtrot API. The only endpoint currently exposed is the route optimization endpoint (Foxtrot.optimize).

In order to make requests, you need a valid API key. Your API key can be found at the bottom of any page in the Foxtrot web app.

Installation

pip install foxtrot-client

Usage

data = {
  "file_url": "https://www.domain.io/your_file.xlsx",
  "file_name": "your_file.xlsx",
  "geocode": "false",
  "stop_name": "Customer",
  "lat": "Lat",
  "lng": "Long",
  "load": "Load",
  "service_time": "Service Time",
  "time_window": "Time Window",
  "extra_info": "Contact Info",
  "date_starting": "1407712069593",
  "warehouse": "77 Massachusetts Ave, Cambridge MA",
  "num_drivers": 1,
  "num_avg_service_time": 10,
  "float_fuel_cost": 3.56,
  "float_driver_wage": 6.01,
  "float_mpg": 8.32
}

api_key = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'

from foxtrot import Foxtrot
fox = Foxtrot(api_key)

resp = fox.optimize(data).poll_and_block()
result = resp.get_result()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

foxtrot-client-0.2.4.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file foxtrot-client-0.2.4.tar.gz.

File metadata

File hashes

Hashes for foxtrot-client-0.2.4.tar.gz
Algorithm Hash digest
SHA256 d5c712bcef91247a3212d04eaa51315a625ec941c65af5c3b1910f940c96b3a5
MD5 5acc976bd5bc40b59b9bc090521e2930
BLAKE2b-256 03bf5e567563a3f523da7688b2f141c9a009da0a16c97f2a2fc783cccb3845cc

See more details on using hashes here.

File details

Details for the file foxtrot-client-0.2.4.macosx-10.6-intel.tar.gz.

File metadata

File hashes

Hashes for foxtrot-client-0.2.4.macosx-10.6-intel.tar.gz
Algorithm Hash digest
SHA256 a5a043e23ddd09b52046afb919aac12e3e8b7639b4d6ccf3388dd0aef71423bf
MD5 35ccff37dfe99d645cbe759bbcaf38e0
BLAKE2b-256 8e2f2c482dfd875dde82499b0ca64ddd761e4345b72a9e999ef439ef5c361df2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page