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.

Listing regions and VMs with the American Cloud Python SDK

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

Guides

Narrative walkthroughs on the American Cloud docs site:

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.3.3.tar.gz (189.4 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.3.3-py3-none-any.whl (335.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for americancloud-1.3.3.tar.gz
Algorithm Hash digest
SHA256 e47cc0eded0fbe10f6c8cbfbc140cc2d0fcc41f269ff9965bb1034492faa8aed
MD5 6ce06c51ac4a21b40b06e1d2b374a362
BLAKE2b-256 c3c331af29e73360011ba10a879ebcfdb883173da1f8d643fd497a1d0e92fbcd

See more details on using hashes here.

Provenance

The following attestation bundles were made for americancloud-1.3.3.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.3.3-py3-none-any.whl.

File metadata

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

File hashes

Hashes for americancloud-1.3.3-py3-none-any.whl
Algorithm Hash digest
SHA256 c01daca50eaa9d0b3c193155127bffe1e487c980360e5af0fd3f20b5dc2ae91a
MD5 d44405b307c7e2cb533bb092238ace92
BLAKE2b-256 4d91baa5b265d13c2fb215b346116c15fc7a5abbeb5bc40e86df00b2ca451989

See more details on using hashes here.

Provenance

The following attestation bundles were made for americancloud-1.3.3-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