Python SDK for StackMachine.
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
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)
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:
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 PyPIProject links
GitHub Statistics
Maintainers
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.4.0.tar.gz
(29.5 kB
view details)
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file stackmachine-0.4.0.tar.gz.
File metadata
- Download URL: stackmachine-0.4.0.tar.gz
- Upload date:
- Size: 29.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
52686539b9cd629871175e3e52193fb617ba85222e1831610d1b361920e38965
|
|
| MD5 |
7c4550d6b330720fe1b5f9adc8c70411
|
|
| BLAKE2b-256 |
290723b9737757fa3857cf154a64fb7b4b79bff62ed7a16f750f726b49e727f2
|
File details
Details for the file stackmachine-0.4.0-py3-none-any.whl.
File metadata
- Download URL: stackmachine-0.4.0-py3-none-any.whl
- Upload date:
- Size: 37.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: uv/0.11.19 {"installer":{"name":"uv","version":"0.11.19","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
50154cc1d56a024fbd62c5971e24ea34da66de671fd75e4ad5c3d3c1251a616e
|
|
| MD5 |
5c843cff046ccad2ecf53f372691a2f6
|
|
| BLAKE2b-256 |
c3490cb1cf80d42b9159320a3a4040942aab702c543a58b7041ef6a8d5f6e1cb
|
