Official Python SDK for the Wandelbots
Project description
wandelbots-nova
This library provides an SDK for the Wandelbots NOVA API.
The SDK will help you to build your own apps and services on top of NOVA and makes programming a robot as easy as possible.
Requirements
This library requires
- Python >=3.10
Installation
To use the library, first install it using the following command
pip install wandelbots-nova
Usage
Import the library in your code to get started.
from nova import Nova
The SDK also includes an auto-generated API client for the NOVA API. You can access the API client using the api module.
from nova import api
Checkout the 01_basic and 02_plan_and_execute examples to learn how to use the library.
In the this directory are more examples to explain the advanced usage of the SDK.
Development
To install the development dependencies, run the following command
poetry install
Environment Variables for NOVA Configuration
- Copy the Template: Make a copy of the provided
.env.templatefile and rename it to.envwithcp .env.template .env. - Fill in the Values: Open the
.envfile in a text editor and provide the necessary values for each variable. The table below describes each variable and its usage.
| Variable | Description | Required | Default | Example |
|---|---|---|---|---|
NOVA_API |
The base URL or hostname of the NOVA server instance. | Yes | None | https://nova.example.com or http://172.0.0.1 |
NOVA_USERNAME |
The username credential used for authentication with the NOVA service. | Yes* | None | my_username |
NOVA_PASSWORD |
The password credential used in conjunction with NOVA_USERNAME. |
Yes* | None | my_password |
NOVA_ACCESS_TOKEN |
A pre-obtained access token for NOVA if using token-based authentication. | Yes* | None | eyJhbGciOi... |
Note on Authentication: You can authenticate with NOVA using either username/password credentials or a pre-obtained access token, depending on your setup and security model:
- If using username/password: Ensure both
NOVA_USERNAMEandNOVA_PASSWORDare set, and leaveNOVA_ACCESS_TOKENunset.- If using an access token: Ensure
NOVA_ACCESS_TOKENis set, and leaveNOVA_USERNAMEandNOVA_PASSWORDunset.Only one method should be used at a time. If both methods are set, the token-based authentication (
NOVA_ACCESS_TOKEN) will typically take precedence.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file wandelbots_nova-0.11.0.tar.gz.
File metadata
- Download URL: wandelbots_nova-0.11.0.tar.gz
- Upload date:
- Size: 21.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5e270f2893436a1b7db4a78fc9f60991f50ad6a5ed34fd9e6b373d5e64463f53
|
|
| MD5 |
a6f2938fbc3519a86eefe2833608c52a
|
|
| BLAKE2b-256 |
83bcab311e34655bbe486c0ad400e48dc074337f6c886443aae7649af4d13eed
|
File details
Details for the file wandelbots_nova-0.11.0-py3-none-any.whl.
File metadata
- Download URL: wandelbots_nova-0.11.0-py3-none-any.whl
- Upload date:
- Size: 24.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.0.1 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
782dbc59b7172f12e63f67914aba7bebe37a56527abbc43ea7ac392df788da54
|
|
| MD5 |
2e8ab21bf49f15831dcf5474e30b9830
|
|
| BLAKE2b-256 |
e6d4e8ad9a7ddd6cfe61be729e00c484026f0f36aad1097412b36f85f62e6172
|
