vantage-sdkpy 0.1.1__tar.gz

vantage_sdkpy-0.1.1/.gitignore

@@ -0,0 +1,68 @@
+__pycache__/
+**/__pycache__/
+**/**/__pycache__/
+
+# Docusaurus
+docs/node_modules
+docs/yarn-global
+docs/yarn-cache
+docs/.docusaurus
+docs/build
+docs/.yarn
+docs/yarn-error.log
+docs/npm-debug.log*
+docs/yarn-debug.log*
+
+
+# Python virtual environments
+.venv
+venv/
+env/
+.env
+**/.env
+
+# Coverage reports
+.coverage
+cover_unit
+cover_integration
+cover_combined
+.coverage.*
+coverage
+cover/
+htmlcov/
+
+# Testing and linting
+.tox/
+.nox/
+.pytest_cache/
+.pytest_cache/**
+.pytest_cache/**/*
+.pytest_cache/**/*
+.ruff_cache/
+.mypy_cache/
+.dmypy.json
+.dmypy.json/**
+.pyre/
+.pyre/**
+.pyre/**/*
+
+# Jupyter
+.ipynb_checkpoints
+
+# IDE and editor files
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+
+# OS generated files
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+*.tar.gz
+*.tgz

vantage_sdkpy-0.1.1/PKG-INFO

@@ -0,0 +1,129 @@
+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)

vantage_sdkpy-0.1.1/README.md

@@ -0,0 +1,95 @@
+<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)

vantage_sdkpy-0.1.1/pyproject.toml

@@ -0,0 +1,112 @@
+[project]
+name = "vantage-sdkpy"
+version = "0.1.1"
+description = "Python SDK for interacting with the Vantage platform."
+authors = [
+    { name = "Vantage Compute", email = "engineering@vantagecompute.ai" },
+]
+readme = "README.md"
+license = { text = "GPL-3.0" }
+requires-python = ">=3.14"
+dependencies = [
+    "aiohttp>=3.13.3",
+    "anyio>=4.12.1",
+    "gql>=4.0.0",
+    "httpx>=0.28.1",
+    "loguru>=0.7.3",
+    "pendulum>=3.2.0",
+    "pydantic>=2.12.5",
+    "py-buzz>=8.0.0",
+    "python-jose[cryptography]>=3.5.0",
+    "pyyaml>=6.0.3",
+    "requests-toolbelt>=1.0.0",
+    "rich>=14.3.2",
+    "ruamel.yaml>=0.19.1",
+    "snick>=3.0.0",
+    "typer>=0.21.1",
+]
+
+[project.optional-dependencies]
+dev = [
+    "black>=26.1.0",
+    "codespell>=2.4.1",
+    "pyright>=1.1.408",
+    "pytest>=9.0.2",
+    "pytest-asyncio>=1.3.0",
+    "pytest-cov>=7.0.0",
+    "respx>=0.22.0",
+    "ruff>=0.15.0",
+    "types-pyyaml>=6.0.12.20250915",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["vantage_sdk"]
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/vantage_sdk",
+    "/README.md",
+]
+
+[tool.coverage.run]
+branch = true
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.coverage.paths]
+source = ["vantage_sdk"]
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+log_cli_level = "INFO"
+filterwarnings = [
+    "ignore::DeprecationWarning:websockets.legacy",
+]
+
+[tool.codespell]
+skip = ".venv,venv,icon.svg,.tox,.git,.mypy_cache,.ruff_cache,.pytest_cache,.vscode,.coverage,cover"
+ignore-words-list = "aks"
+
+[tool.black]
+line-length = 99
+target-version = ["py312"]
+
+[tool.ruff]
+line-length = 99
+lint.select = ["E", "W", "F", "C", "N", "D", "I001"]
+lint.extend-ignore = [
+    "D203",
+    "D204",
+    "D213",
+    "D215",
+    "D400",
+    "D404",
+    "D406",
+    "D407",
+    "D408",
+    "D409",
+    "D413",
+]
+lint.ignore = ["E501", "D107"]
+lint.per-file-ignores = { "**/tests/*" = [
+    "D100",
+    "D101",
+    "D102",
+    "D103",
+    "D104",
+] }
+extend-exclude = ["__pycache__", "*.egg_info"]
+
+[tool.ruff.lint.mccabe]
+max-complexity = 15
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[dependency-groups]
+dev = [
+    "pytest-cov>=7.0.0",
+    "types-pyyaml>=6.0.12.20250915",
+]

vantage_sdkpy-0.1.1/vantage_sdk/__init__.py

@@ -0,0 +1,44 @@
+# Copyright (C) 2025 Vantage Compute Corporation
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, version 3.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <https://www.gnu.org/licenses/>.
+"""Standalone Vantage SDK public exports."""
+
+# Import base classes
+from .base import BaseCRUDSDK, BaseGraphQLResourceSDK
+from .cloud.cloud_account_crud import cloud_account_sdk
+
+from .cluster.crud import cluster_sdk
+from .job import JobScript, JobScriptFile, JobSubmission, JobTemplate
+from .job import job_script_sdk, job_submission_sdk, job_template_sdk
+from .schemas import CliContext, SDKContext
+from .support_ticket.crud import support_ticket_sdk
+from .team.crud import team_sdk
+from .vantage_rest_api_client import VantageRestApiClient, create_vantage_rest_client
+
+__all__ = [
+    "BaseCRUDSDK",
+    "BaseGraphQLResourceSDK",
+    "SDKContext",
+    "CliContext",
+    "cluster_sdk",
+    "cloud_account_sdk",
+    "team_sdk",
+    "support_ticket_sdk",
+    "job_script_sdk",
+    "job_template_sdk",
+    "job_submission_sdk",
+    "JobScript",
+    "JobScriptFile",
+    "JobSubmission",
+    "JobTemplate",
+    "VantageRestApiClient",
+    "create_vantage_rest_client",
+]

vantage_sdkpy-0.1.1/vantage_sdk/admin/__init__.py

@@ -0,0 +1,16 @@
+# Copyright (C) 2025 Vantage Compute Corporation
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, version 3.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <https://www.gnu.org/licenses/>.
+"""Admin SDK package for administrative operations."""
+
+from .management import get_extra_attributes
+
+__all__ = ["get_extra_attributes"]

vantage_sdkpy-0.1.1/vantage_sdk/admin/management/__init__.py

@@ -0,0 +1,16 @@
+# Copyright (C) 2025 Vantage Compute Corporation
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, version 3.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <https://www.gnu.org/licenses/>.
+"""Management SDK module for administrative operations."""
+
+from .organizations import get_extra_attributes
+
+__all__ = ["get_extra_attributes"]

vantage_sdkpy-0.1.1/vantage_sdk/admin/management/organizations.py

@@ -0,0 +1,60 @@
+# Copyright (C) 2025 Vantage Compute Corporation
+# This program is free software: you can redistribute it and/or modify it under
+# the terms of the GNU General Public License as published by the Free Software
+# Foundation, version 3.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program. If not, see <https://www.gnu.org/licenses/>.
+"""Organizations management SDK functions.
+
+This module provides SDK functions for organization-level administrative operations
+such as managing extra attributes and other organization configurations.
+"""
+
+import logging
+from typing import Any, Dict, Optional
+
+import typer
+
+logger = logging.getLogger(__name__)
+
+
+async def get_extra_attributes(ctx: typer.Context) -> Optional[Dict[Any, Any]]:
+    """Get organization extra attributes.
+
+    This function retrieves the list of extra attributes configured for the organization.
+    Extra attributes are custom fields that can be added to various entities.
+
+    The REST client is automatically initialized and attached to ctx.obj.rest_client
+    by the @attach_vantage_rest_client decorator.
+
+    Args:
+        ctx: Typer context with rest_client, settings, and persona already attached
+
+    Returns:
+        Dict of extra attribute data containing the organization's extra attributes,
+        or None if the request fails
+
+    Raises:
+        httpx.HTTPStatusError: If the API request fails
+        Exception: For other request failures
+
+    Example:
+        >>> import typer
+        >>> ctx = typer.Context(...)  # Context with settings and persona
+        >>> attributes = await get_extra_attributes(ctx)
+        >>> print(attributes)
+    """
+    path = "/admin/management/organizations/extra-attributes"
+    try:
+        # The VantageRestApiClient.get() method returns the JSON data directly
+        # (not a response object), so we can return it as-is
+        data = await ctx.obj.rest_client.get(path)
+        return data
+    except Exception as e:
+        logger.warning("Failed to retrieve extra attributes: %s", e)
+        return None