Dev (#7)

* Add FastAPI server and visualization for SimpleAudit results

- Implemented a FastAPI server in `server.py` to serve visualization pages and handle API requests for JSON audit results.
- Created HTML template `visualizer.html` for displaying audit results with a responsive design using Tailwind CSS.
- Added a favicon image `thumbnail.png` for the web application.
- Introduced API endpoints to retrieve the file tree of JSON files and serve individual JSON file contents.
- Implemented validation for JSON files to ensure they contain valid audit results.

* Clarify local web server instructions in README

Updated wording for clarity regarding the local web server.

* Fix path resolution for HTML and favicon files in FastAPI server

* Add package data for visualization assets in setuptools configuration

* Bump version to 0.1.3 and update README with live demo link for visualization

* Bump version from 0.1.3 to 0.1.4 in pyproject.toml

Author: SushantGautam

README.md

@@ -88,7 +88,8 @@ uvx simpleaudit[visualize] serve --results_dir ./my_audit_results
 pip install simpleaudit[visualize]
 simpleaudit serve --results_dir ./my_audit_results
 ```
-This will spin-up a local web server to explore results with scenario details. See [visualization/README.md](simpleaudit/visualization/README.md) for more options and features.
+This will spin-up a local web server to explore results with scenario details. 👉 [Check for live demo.](https://simulamet-simpleauditvisualization.hf.space)
+See [visualization/README.md](simpleaudit/visualization/README.md) for more options and features.
 
 > **Note:** Option 1 requires [`uv`](https://pypi.org/project/uv/) to be installed ([install guide](https://docs.astral.sh/uv/getting-started/installation/)).
 

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simpleaudit"
-version = "0.1.2"
+version = "0.1.4"
 description = "Lightweight AI Safety Auditing Framework"
 readme = "README.md"
 license = {text = "MIT"}
@@ -58,6 +58,12 @@ PyPI = "https://pypi.org/project/simpleaudit/"
 where = ["."]
 include = ["simpleaudit*"]
 
+[tool.setuptools.package-data]
+simpleaudit = [
+    "visualization/*.html",
+    "visualization/*.png",
+]
+
 [tool.black]
 line-length = 100
 target-version = ["py39", "py310", "py311", "py312"]

simpleaudit/visualization/README.md

@@ -21,6 +21,8 @@ simpleaudit serve --results_dir ./my_audit_results
 # Custom port and host
 simpleaudit serve --results_dir ./results --port 8080 --host 0.0.0.0
 ```
+ 👉 [Check for live demo](https://simulamet-simpleauditvisualization.hf.space)
+
 
 **Or run directly with uv (no installation needed):**
 ```bash
@@ -170,18 +172,21 @@ Both visualization methods support these JSON structures:
 ```bash
 # After running your audit
 simpleaudit serve --results_dir ./examples/local_audit_example_results
+<!-- 👉 [Check for demo](https://simulamet-simpleauditvisualization.hf.space) -->
 ```
 
 ### Example 2: Multiple Audits
 ```bash
 # Browse all audits in a directory
 simpleaudit serve --results_dir ./all_audits
+<!-- 👉 [Check for demo](https://simulamet-simpleauditvisualization.hf.space) -->
 ```
 
 ### Example 3: Share with Team
 ```bash
 # Start server on network-accessible host
 simpleaudit serve --results_dir ./results --host 0.0.0.0 --port 8080
+<!-- 👉 [Check for demo](https://simulamet-simpleauditvisualization.hf.space) -->
 ```
 
 Then share: `http://YOUR_IP:8080`
@@ -200,12 +205,14 @@ Then share: `http://YOUR_IP:8080`
 If port 8000 is in use:
 ```bash
 simpleaudit serve --results_dir ./results --port 8001
+<!-- 👉 [Check for demo](https://simulamet-simpleauditvisualization.hf.space) -->
 ```
 
 ### Allow External Access
 To access from other devices on your network:
 ```bash
 simpleaudit serve --results_dir ./results --host 0.0.0.0
+<!-- 👉 [Check for demo](https://simulamet-simpleauditvisualization.hf.space) -->
 ```
 
 ---

simpleaudit/visualization/server.py

@@ -93,7 +93,7 @@ def get_file_tree(directory: str, base_path: str = "") -> List[Dict]:
 @app.get("/")
 async def root():
     """Serve the main visualization page."""
-    html_path = Path(__file__).parent / "visualizer.html"
+    html_path = Path(__file__).resolve().parent / "visualizer.html"
 
     if not html_path.exists():
         return HTMLResponse(
@@ -110,7 +110,7 @@ async def root():
 @app.get("/scenario_viewer.html")
 async def scenario_viewer():
     """Serve the standalone scenario viewer page."""
-    html_path = Path(__file__).parent / "scenario_viewer.html"
+    html_path = Path(__file__).resolve().parent / "scenario_viewer.html"
 
     if not html_path.exists():
         return HTMLResponse(
@@ -127,7 +127,7 @@ async def scenario_viewer():
 @app.get("/favicon.png")
 async def favicon():
     """Serve the favicon."""
-    favicon_path = Path(__file__).parent / "thumbnail.png"
+    favicon_path = Path(__file__).resolve().parent / "thumbnail.png"
 
     if not favicon_path.exists():
         raise HTTPException(status_code=404, detail="Favicon not found")