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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: nextmv-0.1.0.dev17.tar.gz
  • Upload date:
  • Size: 29.5 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.dev17.tar.gz
Algorithm Hash digest
SHA256 d795386a16857cc3350ac8c298ceaaeda1450ed2e4391e837aff6b7338ba8fce
MD5 093d167b3259e80ee72eba8a9ac77ef3
BLAKE2b-256 2fa3289a13785d71ba569cfc385087a2510121a029af2c8e6b869b78af06c986

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for nextmv-0.1.0.dev17-py3-none-any.whl
Algorithm Hash digest
SHA256 dd47831c9f4d813c3e6b5cfb1c1a2238acdcd471aa970d192c1d46b0a0603a4c
MD5 9c35a65c56cef0eb1894b7f8eb2b0de0
BLAKE2b-256 ee48cafb9e921248e4bfa5c2af90ff37acef497bd727a74ea389f3b3d17d3121

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