preswald

preswald

๐Ÿต Preswald is a full-stack platform for building, deploying, and managing interactive data applications. It brings ingestion, storage, transformation, and visualization into a simple SDK, minimizing complexity while maintaining flexibility for both prototyping and production-grade use cases.

Stars: 1049

Visit
 screenshot

Preswald is a full-stack platform for building, deploying, and managing interactive data applications in Python. It simplifies the process by combining ingestion, storage, transformation, and visualization into one lightweight SDK. With Preswald, users can connect to various data sources, customize app themes, and easily deploy apps locally. The platform focuses on code-first simplicity, end-to-end coverage, and efficiency by design, making it suitable for prototyping internal tools or deploying production-grade apps with reduced complexity and cost.

README:

Banner

๐Ÿต Your lightweight companion for building simple, interactive, and dynamic data apps in Python.

Apache 2.0 License Python Version Slack Community PyPI Version

Website Documentation Demo Book a Demo

What is Preswald?

Preswald is a full-stack platform for building, deploying, and managing interactive data applications. It combines ingestion, storage, transformation, and visualization into one lightweight and powerful SDK. Whether you're prototyping internal tools or deploying production-grade apps, Preswald reduces complexity and cost without compromising flexibility.

  • Code-First Simplicity. Minimal Python and SQL for powerful apps
  • End-to-End Coverage. Handle ingestion, ETL, and visualization in one platform
  • Efficient by Design. Avoid the sprawling complexity of the modern data stack while keeping what works.
  • Connect to CSV, JSON, Parquet, or SQL databases in seconds.
  • Fully Customizable Themes. Your app, your brandโ€”just tweak images and names in config.toml.
  • Go live on your machine with a single command.


๐Ÿš€ Getting Started

Installation

First, install Preswald using pip. https://pypi.org/project/preswald/

pip install preswald

Demo GIF

๐Ÿ‘ฉโ€๐Ÿ’ป Quick Start

1. Initialize a New Project

Start your journey with Preswald by initializing a new project:

preswald init my_project
cd my_project

This will create a folder called my_project with all the basics you need:

  • hello.py: Your first Preswald app.
  • config.toml: Customize your appโ€™s settings and style.
  • secrets.toml: Keep your API keys and sensitive information safe.
  • .gitignore: Preconfigured to keep secrets.toml out of your Git repository.

2. Write Your First App

Time to make something magical! Open up hello.py and write:

from preswald import text, connect, view

# Render Markdown content
text("# Welcome to Preswald")

# Connect to a CSV file
data_conn = connect("example.csv", "my_data")

# Display the data as a table
view(data_conn)

Demo GIF

3. Run Your App

Now the fun partโ€”see it in action! Run your app locally with:

preswald run hello.py

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!

4. Deploy Your App to the Cloud

Once you've built and tested your app locally, deploying it to the cloud is just as simple. Preswald integrates with Google Cloud Run, allowing you to host your app in a scalable, serverless environment with just one command.

To deploy your app, set up Google Cloud credentials and a project. Then, run:

preswald deploy hello.py --project <your-gcp-project>

Once deployed, youโ€™ll see a URL where your app is live, for example:

๐ŸŒ App deployed at: https://your-app-name-abc123.run.app

๐Ÿ’ก Examples

Example 1: Hello World

from preswald import text

text("# Hello, World!")

Example 2: Data Viewer

from preswald import connect, view

data_conn = connect("example.csv", "example_data")
view(data_conn)

Example 3: Interactive Dashboard

from preswald import text, slider, view, connect

text("# Interactive Dashboard")

slider_value = slider("Rows to Display", min_val=10, max_val=100, step=10, default=50)
data_conn = connect("example.csv", "data")
view(data_conn, limit=slider_value)

๐Ÿ”ง Configuration

Preswald uses config.toml for project settings and theming. Itโ€™s straightforward, and it makes your app look polished.

Sample config.toml:

[project]
title = "Preswald Project"
version = "0.1.0"
port = 8501

[branding]
logo = "thumbnail.png"
favicon = "favicon.ico"
name = "My app"

[theme.color]
primary = "#4CAF50"
font = "Arial, sans-serif"

[connections.postgres]
type = "postgres"
host = "localhost"
port = 5432
dbname = "mydb"
user = "user"

# password is stored in secrets.toml

๐Ÿ“š Documentation

Weโ€™re here to help! Check out our full documentation at Preswald Docs.


๐Ÿค Contributing

Preswald thrives on community contributions! Hereโ€™s how you can help:

  1. Fork the repository.

  2. Clone your fork:

    git clone https://github.com/StructuredLabs/preswald.git
  3. For local development, with the frontend, run the following commands

    pip install -e ".[dev]"
    python setup.py build_frontend
    python -m build
    pip install dist/preswald-0.xx.xx.tar.gz
    
  4. Run a test app

    preswald run examples/earthquakes.py
    

For details, 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.

For Tasks:

Click tags to check more tools for each tasks

For Jobs:

Alternative AI tools for preswald

Similar Open Source Tools

For similar tasks

For similar jobs