Skip to main content

SDK for building apps on floom

Project description

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

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

floom_sdk-0.1.4.tar.gz (14.7 kB view details)

Uploaded Source

Built Distribution

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

floom_sdk-0.1.4-py3-none-any.whl (9.3 kB view details)

Uploaded Python 3

File details

Details for the file floom_sdk-0.1.4.tar.gz.

File metadata

  • Download URL: floom_sdk-0.1.4.tar.gz
  • Upload date:
  • Size: 14.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for floom_sdk-0.1.4.tar.gz
Algorithm Hash digest
SHA256 459b22af73cbc92f5ee76a56c36d50fe2c856edab3114642f8b70de2ac9c66d7
MD5 d4f52b02c15cf2de2a80496f61610762
BLAKE2b-256 1d2fbe9d031b8f5aeb4c51b4e89c056b8b5c2ea8005c2c46128462d57ccb11ac

See more details on using hashes here.

File details

Details for the file floom_sdk-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: floom_sdk-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 9.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for floom_sdk-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 a1ec29e85a4aa79a3296e965e337b937817a5a079783f45744e0be007e0bbd95
MD5 81ee1c5cb915ae74e979d559b98a9696
BLAKE2b-256 272e40dd3e96c1b2f4723cc56abcd7a9fdaeb5f60cdfdb866518a0e37fb45dca

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