Skip to main content

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()

Metadata

Release files for foxtrot-client 0.2.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for foxtrot-client 0.2.4
File Size Uploaded Provenance
foxtrot-client-0.2.4.tar.gz 4.3 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for foxtrot-client 0.2.4
File Interpreter ABI Platform
foxtrot-client-0.2.4.macosx-10.6-intel.tar.gz Details

Total release size: 12.9 kB

Release files / foxtrot-client-0.2.4.tar.gz

Download URL foxtrot-client-0.2.4.tar.gz
Size 4.3 kB
Tags Source
SHA-256 checksum
How to use checksums
d5c712bcef91247a3212d04eaa51315a625ec941c65af5c3b1910f940c96b3a5
BLAKE2b-256 checksum
How to use checksums
03bf5e567563a3f523da7688b2f141c9a009da0a16c97f2a2fc783cccb3845cc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / foxtrot-client-0.2.4.macosx-10.6-intel.tar.gz

Download URL foxtrot-client-0.2.4.macosx-10.6-intel.tar.gz
Size 8.6 kB
Tags Source
SHA-256 checksum
How to use checksums
a5a043e23ddd09b52046afb919aac12e3e8b7639b4d6ccf3388dd0aef71423bf
BLAKE2b-256 checksum
How to use checksums
8e2f2c482dfd875dde82499b0ca64ddd761e4345b72a9e999ef439ef5c361df2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Security for foxtrot-client 0.2.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page