Streamlit Faker

0.0.4 · active · verified Thu Apr 16

streamlit-faker is a Python library designed to easily fake Streamlit commands. It allows developers to quickly draft a user interface or use it as a QA tool by generating random parameters for Streamlit functions, streamlining the prototyping process. It is built upon the popular `faker` project. The current version is 0.0.4, and it has an active, though not rapid, release cadence.

Common errors

```
ModuleNotFoundError: No module named 'streamlit_faker'
```
cause The `streamlit-faker` package is not installed in the current Python environment.

fix Run `pip install streamlit-faker` to install the library.
```
AttributeError: 'StreamlitFaker' object has no attribute 'non_existent_command'
```
cause Attempting to call a Streamlit command that does not exist or is not supported by the `streamlit-faker` wrapper.

fix Verify the Streamlit command name against the official Streamlit documentation. `streamlit-faker` aims to support common Streamlit commands but might not cover all edge cases or newly introduced APIs immediately.

Warnings

gotcha streamlit-faker is primarily designed for rapid prototyping and UI drafting. It generates plausible, but random, data and may not accurately reflect complex real-world Streamlit app behavior, especially concerning intricate user interactions, state management, or custom components.
Fix: Use for initial layout and visual feedback. For robust testing or complex logic, implement actual Streamlit components with specific test data or a dedicated testing framework.
gotcha When migrating from faked UI to real Streamlit components, ensure proper handling of widget keys (`key` parameter) and `st.session_state` to prevent unexpected behavior. The faked commands automatically handle some aspects, which need manual attention in real code.
Fix: Carefully review and explicitly define `key` arguments for stateful widgets and manage application state via `st.session_state` when replacing `streamlit-faker` calls with actual Streamlit API calls.
deprecated Prior to v0.0.4, the library internally relied on `streamlit-extras`. This dependency was replaced with `altex`. While this was primarily an internal change, users relying on any indirectly exposed `streamlit-extras` functionality might need to adjust their assumptions about underlying components.
Fix: Upgrade to v0.0.4 or later. Ensure your application does not directly or indirectly depend on `streamlit-extras` features that might have been implicitly provided by older `streamlit-faker` versions.

Install

pip install streamlit-faker Install stable version

Imports

get_streamlit_faker
wrong:
```
import streamlit_faker
```
correct:
```
from streamlit_faker import get_streamlit_faker
```
The primary entry point is the `get_streamlit_faker` function, not the module itself.

Quickstart

This quickstart demonstrates how to instantiate `streamlit-faker` and use it to render various Streamlit UI elements with randomly generated content. Run this script with `streamlit run your_app.py`.

import streamlit as st
from streamlit_faker import get_streamlit_faker

st.title("Streamlit Faker Demo")

st_faker = get_streamlit_faker(seed=42) # Optional: set a seed for reproducible fake data

st.subheader("Faked UI Elements:")
st_faker.markdown()
st_faker.selectbox()
st_faker.slider()
st_faker.map()
st_faker.button("Faked Button")

st.info("This entire section was generated with fake data using streamlit-faker.")

view raw JSON →