fluxlit 0.4.1

Production-oriented unified runtime for FastAPI + Streamlit

FluxLit (fluxlit)

One port for FastAPI and Streamlit: a FluxLit app object, a Starlette gateway (Uvicorn), and Streamlit in a managed subprocess.

Docs: fluxlit.readthedocs.io · Security: SECURITY.md

Quick start	Architecture · CLI · Configuration
Deployment · Observability · Rate limiting	Auth recipes · Auth migration · Security · Troubleshooting
API reference	Testing · Contributing · Changelog · Roadmap

Longer product context: PLAN.md.

---

Install

Python 3.10+.

pip install fluxlit

Optional JWT / OIDC / BFF helpers: pip install "fluxlit[auth]" — see Auth recipes.

Hack on FluxLit: git clone this repo, then pip install -e ".[dev]".

---

Quick start

fluxlit new my-app && cd my-app   # optional

app.py:

from fluxlit import FluxLit

app = FluxLit(title="Admin Portal")

@app.api.get("/users")
def users():
    return [{"name": "Ada"}]

@app.page("/")
def home(st, client):
    st.title("Dashboard")
    st.write(client.get("/users").json())

fluxlit dev    # default target app:app; or fluxlit dev your.module:app

• UI: app root on the URL Uvicorn prints (default port 8000).
• API: under /api (e.g. GET /api/users). OpenAPI: /api/docs.
• Health / readiness: /api/healthz, /api/readyz (see Deployment).

In Streamlit, use paths like client.get("/users"), not "/api/users". Secured routes need a client with credentials — Auth recipes.

Routing: /api/* → FastAPI (prefix stripped inside the app); everything else → Streamlit (HTTP + WebSocket). Details: Architecture.

---

CLI (summary)

Command	Role
fluxlit dev	Dev server; optional --reload and --reload-scope (gateway or full)
fluxlit run	Same stack, no reloader (typical in containers)
fluxlit doctor	Import, bind, env sanity checks
fluxlit build	Emit starter Dockerfile + .dockerignore
fluxlit new	Minimal scaffold

Proxy / subpath: FLUXLIT_ROOT_PATH, FLUXLIT_TRUST_PROXY. Full flags and PID file: CLI.

---

Configuration

Precedence: CLI → environment (FLUXLIT_*, .env) → fluxlit.toml / [tool.fluxlit] → defaults.

# fluxlit.toml (optional)
target = "app:app"
gateway_host = "127.0.0.1"
gateway_port = 8000

Variable reference: Configuration.

---

Project layout (sketch)

my_app/
├── app.py
├── fluxlit.toml
├── .env              # not committed
└── pkg/pages/        # optional: discover_pages(...)

---

Contributors

pip install -e ".[dev]"
ruff check src tests && ruff format src tests
python -m pytest -n auto --ignore=tests/e2e -m "not slow"
python -m mypy src/fluxlit

Contributing · Testing

---

Status

Shipped: unified gateway, @app.page / discover_pages, fluxlit.toml, typed ApiClient, health/readiness probes, optional gateway access logs, dev reload scopes, fluxlit[auth], CI (incl. proxy smoke + Playwright e2e). Roadmap: Read the Docs.

MIT — see LICENSE.