updated examples

Author: Vish Devarajan

.gitignore

@@ -1,10 +1,14 @@
 __pycache__/
 *.pyc
 .pytest_cache/
+.mypy_cache/
+.ruff_cache/
 .venv/
 dist/
 build/
 *.egg-info/
+.coverage
 .DS_Store
 .env
-
+.idea/
+*.tgz

README.md

@@ -89,6 +89,10 @@ Enterprise deployments can also enrich emitted events with SSO/user context and
 
 Use `BlackwallFastAPIMiddleware`, `create_flask_middleware()`, `create_langchain_callbacks()`, or `create_llamaindex_callback()` to wire Blackwall into framework or orchestration entry points with less glue code.
 
+### Example guide
+
+Use the wiki-ready examples page at [`wiki/Running-Examples.md`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/wiki/Running-Examples.md) for copy-paste setup and run commands.
+
 ### Zero-config UI and sidecar
 
 Run `python -m blackwall_llm_shield.ui` for a local dashboard, or build from [`Dockerfile`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/Dockerfile) to expose Blackwall as a local sidecar proxy for non-Python stacks.
@@ -395,6 +399,7 @@ Produces signed events you can summarize into operations dashboards or audit pip
 - [`examples/python-fastapi/main.py`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/examples/python-fastapi/main.py)
 - [`examples/python-fastapi/dashboard_model.py`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/examples/python-fastapi/dashboard_model.py)
 - [`examples/python-fastapi/streamlit_app.py`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/examples/python-fastapi/streamlit_app.py)
+- [`wiki/Running-Examples.md`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/wiki/Running-Examples.md)
 
 ## Release Commands
 

wiki/Running-Examples.md

@@ -0,0 +1,61 @@
+# Running Examples
+
+This page is wiki-ready and can be copied directly into the GitHub Wiki for the Python package if you want the examples guide to live there permanently.
+
+## Available Examples
+
+- `examples/python-fastapi`
+
+## FastAPI Gateway Example
+
+Path: [`examples/python-fastapi`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/examples/python-fastapi)
+
+This example shows a Python gateway that applies Blackwall middleware before requests reach your LLM route, plus a small Streamlit dashboard for security visibility.
+
+### Run the API
+
+1. Create and activate a virtual environment.
+2. Install the example requirements.
+3. Copy environment values from [`.env.example`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/examples/python-fastapi/.env.example).
+4. Start the API:
+
+```bash
+cd examples/python-fastapi
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+uvicorn main:app --reload
+```
+
+The API will start on `http://127.0.0.1:8000`.
+
+### Run the Dashboard
+
+In a second terminal, from the same folder:
+
+```bash
+source .venv/bin/activate
+streamlit run streamlit_app.py
+```
+
+### What It Demonstrates
+
+- `BlackwallFastAPIMiddleware` on `/chat`
+- request interception before model access
+- telemetry and audit-friendly event handling
+- a simple local dashboard for security operations
+
+### Main Files
+
+- [`main.py`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/examples/python-fastapi/main.py)
+- [`streamlit_app.py`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/examples/python-fastapi/streamlit_app.py)
+- [`dashboard_model.py`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/examples/python-fastapi/dashboard_model.py)
+- [`requirements.txt`](/Users/vishnu/Documents/blackwall-llm-shield/blackwall-llm-shield-python/examples/python-fastapi/requirements.txt)
+
+## Suggested Wiki Placement
+
+If you want this to live in the GitHub Wiki instead of the repo tree, publish it as:
+
+- `Running Examples`
+
+and keep the in-repo copy as the source of truth for future edits.