Metadata-Version: 2.4
Name: nv-air-sdk
Version: 1.2.0
Summary: Python SDK for creating, running and managing simulations on NVIDIA Air
License: MIT
License-File: LICENSE
Author: Air Team
Author-email: air@nvidia.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Dist: python-dateutil (>=2.9.0.post0,<3.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: requests (>=2.32.0,<3.0.0)
Requires-Dist: urllib3 (>=2.0.0,<3.0.0)
Project-URL: Repository, https://github.com/NVIDIA/nv-air-sdk
Description-Content-Type: text/markdown

# Air SDK

This project provides a Python SDK for interacting with the NVIDIA Air API.

## Documentation

For the full SDK documentation, please refer to the [API & SDK](https://docs.nvidia.com/networking-ethernet-software/nvidia-air-v2/API-SDK/) page on NVIDIA docs.

For tutorials and code examples, please refer to the [examples README](./docs/README.md) in the `docs` directory. There you will find Jupyter notebooks covering various SDK features such as ZTP scripts and simulation import/export.

## Prerequisite

The SDK requires Python 3.10. There are a number of ways to achieve this such as `poetry`, `uv` or `virtualenv`.
The following shows how to achieve this on a few popular OS's using `virtualenv`.

```
# Install Python 3.10
brew install python@3.10  # MacOS
apt-get install python3.10  # Ubuntu/Debian
sudo pacman -S python310  # Arch

# Install, create and activate a Python 3.10 virtual environment
python3.10 -m pip install virtualenv
python3.10 -m virtualenv venv
. venv/bin/activate
```


## Installation

`pip install nv-air-sdk`

## Authentication Options

1. NGC Device Login with `AirApi.with_device_login(email=<YOUR_EMAIL>, org_num=<YOUR_NGC_ORG_NUMBER>)`
2. NGC CLI Login with `AirApi.with_ngc_config()` (or just `AirApi()`)   
3. Explicitly specify an NGC API Key (also known as a Starfleet API Key, or "SAK") by instantiating `AirApi.with_api_key(api_key=<YOUR_STARFLEET_API_KEY>)`

And to use option 2 you will need to have the [NGC CLI](https://org.stg.ngc.nvidia.com/setup/installers/cli) installed and to have configured it with `ngc config set`. This will create a file at `~/.ngc/config` which contains your NGC credentials that will be auto-detected by the Air SDK.


## License

MIT License - see LICENSE file for details

This project will download and install additional third-party open source software projects. Review the license terms of these open source projects before use.

## Contributing

This project is currently not accepting contributions.
