Metadata-Version: 2.4
Name: vantage-sdkpy
Version: 0.1.1
Summary: Python SDK for interacting with the Vantage platform.
Author-email: Vantage Compute <engineering@vantagecompute.ai>
License: GPL-3.0
Requires-Python: >=3.14
Requires-Dist: aiohttp>=3.13.3
Requires-Dist: anyio>=4.12.1
Requires-Dist: gql>=4.0.0
Requires-Dist: httpx>=0.28.1
Requires-Dist: loguru>=0.7.3
Requires-Dist: pendulum>=3.2.0
Requires-Dist: py-buzz>=8.0.0
Requires-Dist: pydantic>=2.12.5
Requires-Dist: python-jose[cryptography]>=3.5.0
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: requests-toolbelt>=1.0.0
Requires-Dist: rich>=14.3.2
Requires-Dist: ruamel-yaml>=0.19.1
Requires-Dist: snick>=3.0.0
Requires-Dist: typer>=0.21.1
Provides-Extra: dev
Requires-Dist: black>=26.1.0; extra == 'dev'
Requires-Dist: codespell>=2.4.1; extra == 'dev'
Requires-Dist: pyright>=1.1.408; extra == 'dev'
Requires-Dist: pytest-asyncio>=1.3.0; extra == 'dev'
Requires-Dist: pytest-cov>=7.0.0; extra == 'dev'
Requires-Dist: pytest>=9.0.2; extra == 'dev'
Requires-Dist: respx>=0.22.0; extra == 'dev'
Requires-Dist: ruff>=0.15.0; extra == 'dev'
Requires-Dist: types-pyyaml>=6.0.12.20250915; extra == 'dev'
Description-Content-Type: text/markdown

<div align="center">
<a href="https://www.vantagecompute.ai/">
	<img src="https://vantage-compute-public-assets.s3.us-east-1.amazonaws.com/branding/vantage-logo-text-black-horz.png" alt="Vantage Compute Logo" width="100" style="margin-bottom: 0.5em;"/>
</a>
</div>
<div align="center">

# Vantage SDKPY
A standalone Python SDK for interacting with Vantage platform resources.

[![License](https://img.shields.io/badge/license-GPLv3-green.svg)](https://www.gnu.org/licenses/gpl-3.0.en.html)
[![Python](https://img.shields.io/badge/python-3.14+-blue.svg)](https://python.org)
[![PyPI](https://img.shields.io/pypi/v/vantage-sdkpy.svg)](https://pypi.org/project/vantage-sdkpy/)

![GitHub Issues](https://img.shields.io/github/issues/vantagecompute/vantage-sdkpy?label=issues&logo=github&style=plastic)
![Pull Requests](https://img.shields.io/github/issues-pr/vantagecompute/vantage-sdkpy?label=pull-requests&logo=github&style=plastic)
![GitHub Contributors](https://img.shields.io/github/contributors/vantagecompute/vantage-sdkpy?logo=github&style=plastic)

</br>

## Quick Start

</div>

### Install from PyPI

```bash
pip install vantage-sdkpy
```

### Install from Source

```bash
git clone https://github.com/vantagecompute/vantage-sdkpy.git
cd vantage-sdkpy
uv sync
```

### Example Usage

```python
import asyncio
from types import SimpleNamespace

from vantage_sdk import cluster_sdk
from vantage_sdk.config import Settings
from vantage_sdk.schemas import SDKContext


async def main() -> None:
	ctx = SDKContext.from_token(
		settings=Settings(vantage_url="https://app.vantagecompute.ai"),
		access_token="<access-token>",
		refresh_token="<refresh-token>",
	)
	typer_ctx = SimpleNamespace(obj=ctx)
	clusters = await cluster_sdk.list(typer_ctx)
	print([cluster.name for cluster in clusters])


asyncio.run(main())
```

## Design Goals

- No terminal rendering responsibilities.
- No filesystem-backed profile or token management.
- Explicit in-memory authentication and settings passed in by the caller.
- Reusable by `vantage-cli` and by external Python consumers.

## Documentation

Visit the documentation site:
**[vantagecompute.github.io/vantage-sdkpy](https://vantagecompute.github.io/vantage-sdkpy)**

- **[Installation Guide](https://vantagecompute.github.io/vantage-sdkpy/installation/)**: Set up the SDK locally or from source.
- **[Usage Guide](https://vantagecompute.github.io/vantage-sdkpy/usage/)**: Build authenticated SDK contexts and query resources.
- **[API Reference](https://vantagecompute.github.io/vantage-sdkpy/api/)**: Auto-generated Python module reference.
- **[Architecture](https://vantagecompute.github.io/vantage-sdkpy/architecture/)**: Understand the standalone SDK boundary.

## Support

- **Issues**: [GitHub Issues](https://github.com/vantagecompute/vantage-sdkpy/issues)
- **Discussions**: [GitHub Discussions](https://github.com/vantagecompute/vantage-sdkpy/discussions)
- **Email**: [james@vantagecompute.ai](mailto:james@vantagecompute.ai)

## License

Copyright &copy; 2025 Vantage Compute Corporation

This project is licensed under the GPLv3 License.

---

Built by [Vantage Compute](https://vantagecompute.ai)
