Skip to main content

Official Python SDK for the American Cloud Platform API.

Project description

American Cloud Python SDK

Typed Python client for the American Cloud public API.

This SDK is auto-generated from the OpenAPI specification using Fern. It targets American Cloud API v1 — see VERSIONING.md for how SDK releases track the API.

Installation

pip install americancloud

Authentication

Every request requires both parts of an American Cloud API key, sent as headers:

Header SDK option
X-API-Client-ID api_key
X-API-Client-Secret api_client_secret

Create and manage keys at console.americancloud.com/api-keys. The client secret is shown once at creation — store it securely. If lost, revoke the key and create a new one.

Each key is scoped at creation:

  • read-onlyGET endpoints only
  • read-write — full access to all resource management endpoints

Quick start

Synchronous

import os
from americancloud import AmericancloudApi

client = AmericancloudApi(
    api_key=os.environ["AMERICANCLOUD_API_CLIENT_ID"],
    api_client_secret=os.environ["AMERICANCLOUD_API_CLIENT_SECRET"],
)

vms = client.vms.list_vms()
print(vms)

Asynchronous

import asyncio
import os
from americancloud import AsyncAmericancloudApi

async def main():
    client = AsyncAmericancloudApi(
        api_key=os.environ["AMERICANCLOUD_API_CLIENT_ID"],
        api_client_secret=os.environ["AMERICANCLOUD_API_CLIENT_SECRET"],
    )
    vms = await client.vms.list_vms()
    print(vms)

asyncio.run(main())

The client is namespaced by resource — client.vms, client.block_storage, client.kubernetes, client.dns_zones, etc.

API endpoint

The SDK targets the American Cloud production API at https://api.americancloud.com by default. To override (e.g. for a self-hosted or internal environment), pass base_url:

client = AmericancloudApi(
    api_key="...",
    api_client_secret="...",
    base_url="https://your-custom-endpoint.example.com",
)

API reference

Versioning

The SDK version matches the API platform version it was generated from — SDK x.y.z is generated from OpenAPI document x.y.z, so the SDK↔API mapping is one-to-one by construction:

  • Patch / minor releases are backward-compatible — safe to upgrade.
  • Major releases track a new API URL version (/api/v2) and may require code changes; check the CHANGELOG first.
  • The 1.x line targets API v1, which remains available for at least six months after a v2 release.
  • Additive API changes (new endpoints, optional fields, enum values) ship within a version — tolerate unknown fields and new enum values gracefully.

See VERSIONING.md for the full policy.

Reporting issues

Open an issue against this repository, or contact American Cloud support.

Contributing

This SDK is generated — do not edit the source by hand. See CONTRIBUTING.md for the generation workflow.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

americancloud-1.2.2.tar.gz (181.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

americancloud-1.2.2-py3-none-any.whl (328.9 kB view details)

Uploaded Python 3

File details

Details for the file americancloud-1.2.2.tar.gz.

File metadata

  • Download URL: americancloud-1.2.2.tar.gz
  • Upload date:
  • Size: 181.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for americancloud-1.2.2.tar.gz
Algorithm Hash digest
SHA256 c8a6e051550cfcf25ee3a24a8efe9bb5bf2a3ba9a1a9ef2fb0fc83586b6417f8
MD5 641b8afdb28b62dad1643163fde2d5eb
BLAKE2b-256 62024a2ec5788ede2c505594672a1567cd905b09828f98f330559678e4032072

See more details on using hashes here.

Provenance

The following attestation bundles were made for americancloud-1.2.2.tar.gz:

Publisher: release.yml on American-Cloud/americancloud-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file americancloud-1.2.2-py3-none-any.whl.

File metadata

  • Download URL: americancloud-1.2.2-py3-none-any.whl
  • Upload date:
  • Size: 328.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for americancloud-1.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 62e01dcb36db76dd6d41e822008e5db103cee4f17d188f5f027c120add61597e
MD5 22bc26ba36046a2f44e8105b7af4da00
BLAKE2b-256 cdc6715071b224445eb377012603b638ed569e35aff2202ddc875008e747b5e8

See more details on using hashes here.

Provenance

The following attestation bundles were made for americancloud-1.2.2-py3-none-any.whl:

Publisher: release.yml on American-Cloud/americancloud-sdk-python

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page