satxcloud 0.2.0

Typed Python client library for SatxCloud API

satxcloud

Typed Python client library for the SatxCloud API.

Features

• Layered architecture: client -> services -> transport
• Typed dataclass models for core entities
• Explicit error hierarchy (ApiError, TransportError, AuthenticationError)
• Support for X-API-Key and Bearer auth modes
• Public endpoints available without API key

Installation

pip install satxcloud

Quick Start

from satxcloud import SatxCloudClient, ApiError

client = SatxCloudClient(api_key="YOUR_KEY")

try:
    plans = client.catalog.list_plans()  # no auth required
    print(plans[0].id, plans[0].name)

    servers = client.servers.list_servers()  # auth required
    for s in servers:
        print(s.vmid, s.name, s.server_type, s.status)
except ApiError as e:
    print(e.status_code, e.error_code, e.message)

Architecture

• satxcloud.client.SatxCloudClient: composition root and public facade
• satxcloud.transport.HttpTransport: HTTP concerns, auth headers, error mapping
• satxcloud.services.catalog.CatalogService: plans and availability
• satxcloud.services.servers.ServersService: server lifecycle operations
• satxcloud.models: typed API entities and operation results

Service Methods

Catalog

• list_plans()
• plans_availability()

Servers

• list_servers()
• create_server(...)
• server_details(vmid)
• server_status(vmid)
• start(vmid)
• stop(vmid)
• restart(vmid)
• renew(vmid, months=None)
• change_password(vmid, new_password=None)
• create_backup(vmid)
• list_backups(vmid)
• restore_backup(vmid, volid)
• delete_backup(vmid, volid)
• reinstall_os(vmid, template, password=None)

Development

pip install -e .[dev]
pytest

Release to PyPI

python -m build
python -m twine check dist/*
python -m twine upload dist/*

For TestPyPI:

python -m twine upload --repository testpypi dist/*