Python SDK for StackMachine.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for syrusakbary from gravatar.com syrusakbary

Unverified details

These details have not been verified by PyPI
Meta
  • Requires: Python >=3.9
Classifiers
Report project as malware

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 configuration options during initialization:

stackmachine = StackMachine(
    "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(
    app_name="hello-stackmachine",
    owner="stackmachine",
    files={
        "index.html": "<html><body><h1>Hello StackMachine</h1></body></html>",
    },
    on_upload_progress=lambda progress: print("Uploading", progress.percent * 100),
)

version = deployment.wait()

deployment = stackmachine.apps.autobuild(
    app_name="hello-stackmachine",
    owner="stackmachine",
    files={
        "index.html": "<html><body><h1>Hello StackMachine</h1></body></html>",
    },
)

Files

Use this path only for manual package uploads:

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)

Volumes

volume = stackmachine.apps.volumes.create(
    app="app_id",
    mount_path="/data",
    max_size_bytes=1_073_741_824,
)

volumes = stackmachine.apps.volumes.list(app="app_id", limit=25)
updated = stackmachine.apps.volumes.update(
    volume.id,
    mount_path="/uploads",
    s3_enabled=True,
)
stackmachine.apps.volumes.delete(updated.id)

Git Connections

connection = stackmachine.apps.git.connect(
    app="app_id",
    installation_repo_id="github_installation_repo_id",
    deploy_branch="main",
)

connection = stackmachine.apps.git.retrieve("app_id")
updated = stackmachine.apps.git.update(
    "app_id",
    deploy_branch="main",
    deployment_status_events=True,
    pull_request_comments=True,
)
stackmachine.apps.git.delete("app_id")

Usage Analytics

app_usage = stackmachine.usage.metrics(
    app="app_id",
    start="2026-06-01T00:00:00Z",
    end="2026-06-30T00:00:00Z",
    grouped_by="BY_DAY",
)

workspace_usage = stackmachine.usage.metrics(
    owner="my-workspace",
    start="2026-06-01T00:00:00Z",
    end="2026-06-30T00:00:00Z",
)

print(app_usage.totals.requests.total_requests)
print(workspace_usage.totals.workloads.real_cpu_time_millis)

Databases

result = stackmachine.apps.databases.create(
    app="app_id",
    db_engine="POSTGRES",
    name="primary",
)

database = result.database
password = result.password

databases = stackmachine.apps.databases.list(app="app_id", limit=25)
rotated = stackmachine.apps.databases.rotate_credentials(database.id)
stackmachine.apps.databases.delete(database.id)

Hosted DNS

Hosted DNS is exposed at stackmachine.dns. App domains remain under stackmachine.apps.domains.

domain = stackmachine.dns.domains.create(
    name="example.com",
    owner="owner_id",
    import_records=True,
)

domains = stackmachine.dns.domains.list(owner="owner_id", limit=25)
domain = stackmachine.dns.domains.retrieve_by_name("example.com")

record = stackmachine.dns.records.create(
    domain=domain.id,
    kind="A",
    name="@",
    value="192.0.2.1",
    ttl=300,
)

record = stackmachine.dns.records.update(
    record.id,
    domain=domain.id,
    kind="A",
    name="@",
    value="192.0.2.2",
    ttl=300,
)

stackmachine.dns.records.delete(record.id)
stackmachine.dns.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...",
)

Emails

app_sent = stackmachine.emails.sent.list(app="app_id", limit=25)
owner_received = stackmachine.emails.received.list(owner="owner_id", limit=25)

sent_from_app = (
    stackmachine.apps.retrieve(app_sent.data[0].app_id)
    if app_sent.data and app_sent.data[0].app_id
    else None
)

message = stackmachine.emails.send(
    app="app_id",
    to=["user@example.com"],
    subject="Hello from StackMachine",
    text_body="Plain text body",
    html_body="<p>HTML body</p>",
)

raw_message = stackmachine.emails.send(
    app="app_id",
    to=["user@example.com"],
    subject="Raw MIME from StackMachine",
    raw_message=(
        b"From: app@example.com\r\n"
        b"To: user@example.com\r\n"
        b"Subject: Raw MIME from StackMachine\r\n\r\n"
        b"Plain text body"
    ),
)

Request Options

Most methods accept request_options for per-request configuration:

from stackmachine import RequestOptions

app = stackmachine.apps.retrieve(
    "app_id",
    request_options=RequestOptions(
        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 mypy
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

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for syrusakbary from gravatar.com syrusakbary

Unverified details

These details have not been verified by PyPI
Meta
  • Requires: Python >=3.9
Classifiers

Release history Release notifications | RSS feed

0.6.0

This version

0.5.0

0.4.0

0.3.3

0.3.2

0.3.1

0.3.0

0.2.1

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.5.0.tar.gz (54.2 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.5.0-py3-none-any.whl (56.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: stackmachine-0.5.0.tar.gz
  • Upload date:
  • Size: 54.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","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.5.0.tar.gz
Algorithm Hash digest
SHA256 494f27331f48641704688d89b5db984e2ca6b1208f95c87d55e8e00f13f0e732
MD5 15cedb13d084a8a771a3ec961d81d7b7
BLAKE2b-256 b283b5c4c0f4da82ee23d2e3cbf7f3d911222284a6391c28fe6694ac180ee3ba

See more details on using hashes here.

File details

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

File metadata

  • Download URL: stackmachine-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 56.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.26 {"installer":{"name":"uv","version":"0.11.26","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.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 14194f711dcb36793884d612f62eb0a36621c66b1fe3761831c2d2a0b0f109ea
MD5 b26cd3a239410408a276f836ca2f5565
BLAKE2b-256 b138588abdc11405c88f22f37cbf5ecfb5550662d09979723bbe355142bacfb1

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