Skip to main content

A lightweight data workflow SDK

Project description

Banner

Create interactive data apps with a full data stack that runs in the browser (no local dependencies!),runs offline, and is shareable in a single file.

Apache 2.0 License Python Version Slack Community PyPI Version

Website Documentation Studio Book a Demo

What is Preswald?

Preswald is a static-site generator for building interactive data apps in Python. It packages compute, data access, and UI into self-contained data apps that run locally in the browser. Built on a WASM runtime with Pyodide and DuckDB, Preswald enables portable, file-based apps that are fast, reactive, and shareable.

You can think of Preswald as a lightweight alternative to heavier web app platforms. It provides built-in UI components and reactive state tracking, so you can use it to build dashboards, reports, prototypes, workflows, and notebooks that are reactive, portable, and secure by default.

Preswald is especially useful when:

  • You want to bundle logic, UI, and data into a shareable file
  • You need to ship a tool to a stakeholder who shouldn't need to install anything
  • You're working with sensitive data and want full local control
  • You want to give AI systems structured, modifiable tools

Key Features

  • Code-based. Write apps in Python, not in notebooks or JS frameworks
  • File-first. One command creates a fully-packaged .html app
  • Built for computation. Use Pyodide + DuckDB directly in-browser
  • Composable UI. Use prebuilt components like tables, charts, forms
  • Reactive engine. Only re-run what's needed, powered by a DAG of dependencies
  • Local execution. No server. Runs offline, even with large data
  • AI-ready. Apps are fully inspectable and modifiable by agents

Export as a Static App

preswald export

This command builds your app into a static site inside dist/. The folder contains all the files needed to run your app locally or share it.

  • Works offline in any modern browser
  • Bundles your Python code (via Pyodide), data, and DuckDB queries
  • Preserves app UI, logic, and reactive state
  • Shareable as a file folder or embeddable in hosting platforms

Installation

https://pypi.org/project/preswald/

pip install preswald

or 

uv pip install preswald

Demo GIF

Quick Start

pip install preswald
preswald init my_app
cd my_app
preswald run

This will create a folder called my_app:

my_app/
├── hello.py           # Your app logic
├── preswald.toml      # App metadata and config
├── secrets.toml       # Secrets (e.g. API keys)
├── data/sample.csv    # Input data files
├── images/logo.png    # Custom branding

Edit hello.py to build your app.

from preswald import text, table, get_df

text("# Hello Preswald")
df = get_df("sample.csv")
table(df)
...

Now run your app locally with:

preswald run

This command launches a development server, and Preswald will let you know where your app is hosted. Typically, it’s here:

🌐 App running at: http://localhost:8501

Open your browser, and voilà—your first Preswald app is live!

Configuration

Preswald uses a simple preswald.toml file for configuration. This defines the app's metadata, runtime settings, UI branding, and data sources. Here's a sample:

[project]
title = "Preswald Project"
version = "0.1.0"
port = 8501
slug = "preswald-project"
entrypoint = "hello.py"

[branding]
name = "Preswald Project"
logo = "images/logo.png"
favicon = "images/favicon.ico"
primaryColor = "#F89613"

[logging]
level = "INFO"  # Options: DEBUG, INFO, WARNING, ERROR, CRITICAL
format = "%(asctime)s - %(name)s - %(levelname)s - %(message)s"

Use Cases


📚 Documentation

We’re here to help! Check out our full documentation at Preswald Docs.


🤝 Contributing

Check out CONTRIBUTING.md.


🎉 Join the Community

  • GitHub Issues: Found a bug? Let us know here.
  • Community Forum: Reach out here
  • Discussions: Share your ideas and ask questions in our discussion forum.
  • Contributors: Meet the awesome people who make Preswald better here.

📢 Stay Connected

Follow us on LinkedIn Follow us on Twitter

📄 License

Preswald is licensed under the Apache 2.0 License.

✨ Contributors

Thanks to everyone who has contributed to Preswald 💜

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

preswald-0.1.59-py3-none-any.whl (4.0 MB view details)

Uploaded Python 3

File details

Details for the file preswald-0.1.59-py3-none-any.whl.

File metadata

  • Download URL: preswald-0.1.59-py3-none-any.whl
  • Upload date:
  • Size: 4.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for preswald-0.1.59-py3-none-any.whl
Algorithm Hash digest
SHA256 2ee72905eee6f4f02d86d327988941d2f35024cfc4a3b16dc496fd77200e8d12
MD5 8bcd25d0d95bc740a8bb1681c06e78b9
BLAKE2b-256 8ed1c5055a132b23f620752bf720d38eba585088e92f79a4430705a7d842c23e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page