Skip to main content

Python SDK for StackMachine.

Project description

StackMachine Python SDK

Python SDK for StackMachine. It mirrors the JavaScript SDK surface with a Pythonic sync client and a native async client.

Installation

uv add stackmachine

Usage

from stackmachine import StackMachine

with StackMachine("sk_stackmachine_...") as stackmachine:
    app = stackmachine.apps.retrieve_by_name("my-app")
    print(app.url)
from stackmachine import AsyncStackMachine

async with AsyncStackMachine("sk_stackmachine_...") as stackmachine:
    app = await stackmachine.apps.retrieve_by_name("my-app")
    print(app.url)

Clients

StackMachine exposes sync methods. AsyncStackMachine exposes the same resource tree with awaitable methods.

from stackmachine import AsyncStackMachine, StackMachine

stackmachine = StackMachine("sk_stackmachine_...")
async_stackmachine = AsyncStackMachine("sk_stackmachine_...")

Both clients accept JavaScript-style aliases during initialization:

stackmachine = StackMachine.init(
    {
        "token": "sk_stackmachine_...",
        "apiUrl": "https://api.stackmachine.com/graphql",
        "maxNetworkRetries": 2,
    }
)

Apps

apps = stackmachine.apps.list(limit=10)

for app in apps:
    print(app.id, app.name)

app = stackmachine.apps.retrieve("app_id")
app = stackmachine.apps.retrieve_by_name("my-app")
apps = stackmachine.apps.retrieve_many(["app_1", "app_2"])
stackmachine.apps.delete("app_id")

Async lists can either be awaited for the first page or iterated directly:

apps = async_stackmachine.apps.list(limit=10)
first_page = await apps

async for app in apps:
    print(app.name)

Deployments

deployment = stackmachine.deployments.create(
    {
        "file": "https://example.com/app.zip",
        "name": "my-app",
    }
)

version = deployment.wait()
deployment = stackmachine.apps.autobuild(
    {
        "file": "https://example.com/app.zip",
        "name": "my-app",
    }
)

Files

from stackmachine import create_zip

zip_bytes = create_zip({"index.html": "<h1>Hello</h1>"})
url = stackmachine.files.upload(zip_bytes)

Domains

domain = stackmachine.apps.domains.create(
    app="app_id",
    hostname="example.com",
)

is_verified = stackmachine.apps.domains.verify(domain.id)
stackmachine.apps.domains.delete(domain.id)

SSH

server = stackmachine.apps.ssh.retrieve("app_id")
server = stackmachine.apps.ssh.update("app_id", enabled=True)
token = stackmachine.apps.ssh.tokens.create(app="app_id")

users = stackmachine.apps.ssh.users.list(app="app_id")
user = stackmachine.apps.ssh.users.retrieve("ssh_user_id")
password = stackmachine.apps.ssh.users.passwords.rotate("ssh_user_id")

key = stackmachine.apps.ssh.users.authorized_keys.create(
    user="ssh_user_id",
    public_key="ssh-ed25519 AAAA...",
)

Request Options

Most methods accept request_options for per-request configuration:

app = stackmachine.apps.retrieve(
    "app_id",
    request_options={
        "api_key": "sk_stackmachine_other",
        "timeout": 30,
        "idempotency_key": "deploy-123",
    },
)

Development

cd python
uv sync --dev
uv run ruff check src examples tests
uv run pytest
uv build --no-sources

Manual Publish

Use this path only for manual package uploads:

cd python
uv sync --dev
uv build --no-sources
uv publish

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

stackmachine-0.3.0.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

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

stackmachine-0.3.0-py3-none-any.whl (31.4 kB view details)

Uploaded Python 3

File details

Details for the file stackmachine-0.3.0.tar.gz.

File metadata

  • Download URL: stackmachine-0.3.0.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for stackmachine-0.3.0.tar.gz
Algorithm Hash digest
SHA256 af1d8721dd3761845fcb8b0f4a1e9655cd791a9df84cdd928bab5041e738b030
MD5 21010ad94a5aa64287cd6f0176c148aa
BLAKE2b-256 268725a027466ec5a572757703e678525107cdfd9e7ff87badbc10d253ee1af5

See more details on using hashes here.

File details

Details for the file stackmachine-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: stackmachine-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 31.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.17 {"installer":{"name":"uv","version":"0.11.17","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for stackmachine-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 630ce21b1c05f1ed05799b779dfe7b1bae2c4ad09ed7e81cb470516bb031f6d7
MD5 0c072c486fd20b526a87fa38fbf4541d
BLAKE2b-256 afab49b7bf040bbf507be88dfc48ff27537924097b823b088e7869c1dd6efcf0

See more details on using hashes here.

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