floom-sdk 0.1.5

Turn Python functions into web apps. Type hints become UI, API, and shareable links.

floom SDK

Python SDK for building apps on floom.

Installation

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

pip install -e .

Or install from PyPI:

pip install floom-sdk

Quick Start

from floom 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 floom, 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=floom --cov-report=html

License

MIT