Skip to main content

Runtime Python SDK and CLI

Project description

runtime-sdk

Python SDK and CLI for Runtime.

Install

uv tool install runtime-sdk

To upgrade an existing install:

uv tool upgrade runtime-sdk

Configure

The CLI talks to http://127.0.0.1:8080 by default. Override it with:

export RUNTIME_BASE_URL=https://api.runruntime.dev

Or pass --base-url per command.

Usage

# Auth
runtime login you@example.com
runtime verify 123456
runtime whoami
runtime logout
runtime login --api-key rt_live_...

# Computers
runtime create
runtime list
runtime info <id>
runtime run <id> "echo hello"
runtime run <id> "apt install -y nodejs" --uid 0
runtime publish <id> 3000
runtime delete <id>

Python

from runtime_sdk import RuntimeClient

client = RuntimeClient(base_url="https://api.runruntime.dev", api_key="rt_live_...")

# Create a computer
computer = client.create_computer()
print(computer["public_url"])  # https://goldbird.runruntime.dev

# Run a command
result = client.run_command(computer["id"], "echo hello")
print(result["stdout"])

# Pin the public URL to a local app port
client.publish_port(computer["id"], 3000)

# List, info, delete
computers = client.list_computers()
info = client.get_computer(computer["id"])
client.delete_computer(computer["id"])

Development

For fast local backend iteration:

make local-backend

For deploying and testing against the Hetzner production server:

make sync SERVER_IP=x.x.x.x SSH_USER=root
make smoke

Use make deploy instead of make sync when migrations, env files, Caddy, or systemd units changed.

Run the SDK unit tests through the backend project environment:

uv run python -m unittest scripts.tests.test_runtime_sdk

Release

Preview the next release without changing files:

./scripts/release_runtime_sdk.sh --dry-run

Publish a patch release:

./scripts/release_runtime_sdk.sh --publish

Publish a different version bump:

./scripts/release_runtime_sdk.sh --bump minor --publish

The script loads backend/.env automatically, so UV_PUBLISH_TOKEN can live there.

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

runtime_sdk-0.2.1.tar.gz (13.0 kB view details)

Uploaded Source

Built Distribution

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

runtime_sdk-0.2.1-py3-none-any.whl (12.8 kB view details)

Uploaded Python 3

File details

Details for the file runtime_sdk-0.2.1.tar.gz.

File metadata

  • Download URL: runtime_sdk-0.2.1.tar.gz
  • Upload date:
  • Size: 13.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for runtime_sdk-0.2.1.tar.gz
Algorithm Hash digest
SHA256 4e066608fc9ffd108705b53c7cb5593814be7f0439396a53a54148590844d1d5
MD5 ff2372b13a21d08d9261dbc821252ca4
BLAKE2b-256 b9a61810e7a7ee8a05df1a658e8e648183c60388e4cee4a401a55a72feec802f

See more details on using hashes here.

File details

Details for the file runtime_sdk-0.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for runtime_sdk-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 85568dcf1e43391692c77081fae15d3618a68d316c53c95584da3a7b0497e399
MD5 ab1bd43655fb9d169e04fbb9edbebd97
BLAKE2b-256 5e2482cf32d29069fd4e9e0eb924578d5d96b3c94e5e1947f5fe2c895679990b

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