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.dev12.tar.gz (29.6 kB view details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: nextmv-0.1.0.dev12.tar.gz
  • Upload date:
  • Size: 29.6 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.dev12.tar.gz
Algorithm Hash digest
SHA256 423eaa010abffa2f9db4698440374025ba190cf8721bdf9f15ac6839e7f84cb8
MD5 d7df4d3cb9a149286c04524ae5e49c3e
BLAKE2b-256 70d2b7dac8a973ed767e470427b42fa59c38bf9377b9cf0fab2d5985b54033b5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nextmv-0.1.0.dev12-py3-none-any.whl
Algorithm Hash digest
SHA256 9dcee4220bb1ae93cc62fb95e4cf1df5dd6026143661d50bcbaad8d3ae973dd2
MD5 3d9545bf434658f7c61d4f3f22522edf
BLAKE2b-256 8d61557b7987ded2ade997081ad14d79f995fe97444b3eed44226e124fdb4656

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