Skip to main content

SDK for building apps on RunIt

Project description

RunIt SDK

Python SDK for building apps on RunIt.

Installation

The SDK is automatically available in the RunIt runtime. For local development:

pip install -e .

Or install from PyPI:

pip install runit-sdk

Quick Start

from runit import app, remember

@app.action
def greet(name: str) -> dict:
    visits = (remember("visits") or 0) + 1
    remember("visits", visits)
    return {"message": f"Hello, {name}! Visit #{visits}"}

Paste this into RunIt, hit "Go Live," and share the link.

Features

  • @app.action - Mark functions as runnable actions with auto-generated UI
  • remember() / forget() - Built-in key-value storage across runs
  • storage - Full storage API (get, set, delete, list)
  • save_artifact() - Write outputs that users can download
  • save_dataframe() - Save pandas/polars DataFrames in multiple formats
  • context - Access secrets and uploaded JSON data
  • Zero Dependencies - Core functionality has no required dependencies

Documentation

See the SDK Guide for complete documentation and examples.

Sample Apps

Check out the sample apps in ../samples/:

  • hello-world - Minimal greeting action
  • extract-company - URL scraping with artifacts
  • image-analysis - File upload and image processing
  • bulk-processor - Batch processing with error handling
  • opendraft - Multi-action app example

Development

# Install with dev dependencies
pip install -e ".[dev]"

# Run tests
pytest

# Run tests with coverage
pytest --cov=runit --cov-report=html

License

MIT

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

runit_sdk-0.1.1.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

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

runit_sdk-0.1.1-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file runit_sdk-0.1.1.tar.gz.

File metadata

  • Download URL: runit_sdk-0.1.1.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for runit_sdk-0.1.1.tar.gz
Algorithm Hash digest
SHA256 44e362d67cdd674d52f20db6e18eb56127398f6d7aaef0f66e69fe7ab9c834fa
MD5 09a51ac35f9ed9e5dd07f1849f1c1efa
BLAKE2b-256 6933ab54f28ae585072902e5363648c24812107079533afcd33c11fcecda6a3f

See more details on using hashes here.

Provenance

The following attestation bundles were made for runit_sdk-0.1.1.tar.gz:

Publisher: publish.yml on buildingopen/runit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file runit_sdk-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: runit_sdk-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for runit_sdk-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4d20f38449f83fd308726557ef973a74b59800a1097d0e04c563d312b74716a1
MD5 c26a8603fed263c5ade23632ef8aa5ad
BLAKE2b-256 84b6ba220bbd946532dd449ebfdc093a2b235d8343c3540bcb2a4d27a8aece28

See more details on using hashes here.

Provenance

The following attestation bundles were made for runit_sdk-0.1.1-py3-none-any.whl:

Publisher: publish.yml on buildingopen/runit

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