Skip to main content

The Python SDK for Nextmv

Project description

Nextmv Python SDK

This is the Python SDK for the Nextmv Platform. Before starting:

  1. Sign up for a Nextmv account.
  2. Get your API key. Go to Team > API Key.

Visit the docs for more information.

Installation

Install using pip:

pip install nextmv

Usage

Make sure that you have your API key set as an environment variable:

export NEXTMV_API_KEY=<your-API-key>

Additionally, you must have a valid app in the Nextmv Cloud.

  • Make a run and get the results.
import os

from nextmv.cloud import Application, Client

input = {
    "defaults": {"vehicles": {"speed": 20}},
    "stops": [
        {
            "id": "Nijō Castle",
            "location": {"lon": 135.748134, "lat": 35.014239},
            "quantity": -1,
        },
        {
            "id": "Kyoto Imperial Palace",
            "location": {"lon": 135.762057, "lat": 35.025431},
            "quantity": -1,
        },
    ],
    "vehicles": [
        {
            "id": "v2",
            "capacity": 2,
            "start_location": {"lon": 135.728898, "lat": 35.039705},
        },
    ],
}

client = Client(api_key=os.getenv("NEXTMV_API_KEY"))
app = Application(client=client, id="your-app-id")
result = app.new_run_with_result(
    input=input,
    instance_id="latest",
    run_options={"solve.duration": "1s"},
)
print(result.to_dict())

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

nextmv-0.1.0.dev5.tar.gz (29.1 kB view details)

Uploaded Source

Built Distribution

nextmv-0.1.0.dev5-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

Details for the file nextmv-0.1.0.dev5.tar.gz.

File metadata

  • Download URL: nextmv-0.1.0.dev5.tar.gz
  • Upload date:
  • Size: 29.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for nextmv-0.1.0.dev5.tar.gz
Algorithm Hash digest
SHA256 69028bac675a1533aa8af229ebb22d5421f33c6340f423347ad26d874dedac08
MD5 105ecc38881fd8e161ae078017ce243e
BLAKE2b-256 0c6405a39f15eb397919d07bc03010b0b4c7e784f452672db5c5c97da7f8f894

See more details on using hashes here.

File details

Details for the file nextmv-0.1.0.dev5-py3-none-any.whl.

File metadata

  • Download URL: nextmv-0.1.0.dev5-py3-none-any.whl
  • Upload date:
  • Size: 27.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.12.1

File hashes

Hashes for nextmv-0.1.0.dev5-py3-none-any.whl
Algorithm Hash digest
SHA256 5cab282ce329fbe1a9280cbd8dfd9bcbdfd4caf7913fe639f0e4cc518cee60ce
MD5 1bf87dc51f51ba437305cd80b30c6b7c
BLAKE2b-256 740500cc25282fab1aaa1cffa8079425a9bd97d4e77fc48ff9a9b4ac50115fdc

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