fastapi-radar 0.1.3__py3-none-any.whl → 0.1.5__py3-none-any.whl

fastapi_radar/__init__.py

@@ -2,5 +2,5 @@
 
 from .radar import Radar
 
-__version__ = "0.1.0"
+__version__ = "0.1.5"
 __all__ = ["Radar"]

fastapi_radar/radar.py

@@ -18,7 +18,7 @@ class Radar:
     def __init__(
         self,
         app: FastAPI,
-        db_engine: Engine,
+        db_engine: Optional[Engine] = None,
         storage_engine: Optional[Engine] = None,
         dashboard_path: str = "/__radar",
         max_requests: int = 1000,
@@ -37,6 +37,7 @@ class Radar:
         self.capture_sql_bindings = capture_sql_bindings
         self.exclude_paths = exclude_paths or []
         self.theme = theme
+        self.query_capture = None  # Initialize to None
 
         # Add all radar paths to excluded paths - exclude everything under /__radar
         if dashboard_path not in self.exclude_paths:
@@ -61,7 +62,11 @@ class Radar:
 
         # Initialize components
         self._setup_middleware()
-        self._setup_query_capture()
+
+        # Only setup query capture if db_engine is provided
+        if self.db_engine:
+            self._setup_query_capture()
+
         self._setup_api()
         self._setup_dashboard()
 
@@ -120,7 +125,6 @@ class Radar:
 
         # Add a catch-all route for the dashboard SPA
         # This ensures all sub-routes under /__radar serve the index.html
-        @self.app.get(f"{self.dashboard_path}")
         @self.app.get(f"{self.dashboard_path}/{{full_path:path}}")
         async def serve_dashboard(request: Request, full_path: str = ""):
             # Check if it's a request for a static asset

{fastapi_radar-0.1.3.dist-info → fastapi_radar-0.1.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-radar
-Version: 0.1.3
+Version: 0.1.5
 Summary: A debugging dashboard for FastAPI applications with real-time monitoring
 Home-page: https://github.com/doganarif/fastapi-radar
 Author: Arif Dogan
@@ -28,8 +28,6 @@ Requires-Dist: fastapi>=0.68.0
 Requires-Dist: sqlalchemy>=1.4.0
 Requires-Dist: pydantic>=1.8.0
 Requires-Dist: starlette>=0.14.2
-Requires-Dist: black>=24.8.0
-Requires-Dist: httpx>=0.28.1
 Provides-Extra: dev
 Requires-Dist: pytest>=7.0.0; extra == "dev"
 Requires-Dist: pytest-asyncio>=0.21.0; extra == "dev"
@@ -38,21 +36,22 @@ Requires-Dist: black>=22.0.0; extra == "dev"
 Requires-Dist: isort>=5.10.0; extra == "dev"
 Requires-Dist: flake8>=4.0.0; extra == "dev"
 Requires-Dist: mypy>=0.950; extra == "dev"
+Requires-Dist: httpx>=0.28.1; extra == "dev"
 Dynamic: author
 Dynamic: home-page
 Dynamic: license-file
 Dynamic: requires-python
 
-# FastAPI Radar 🛰️
+# FastAPI Radar
 
 [![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/downloads/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 **A debugging dashboard for FastAPI applications providing real-time request, database query, and exception monitoring.**
 
-✨ **Just one line to add powerful monitoring to your FastAPI app!**
+**Just one line to add powerful monitoring to your FastAPI app!**
 
-## 🎯 See it in Action
+## See it in Action
 
 ![FastAPI Radar Dashboard Demo](./assets/demo.gif)
 
@@ -76,6 +75,8 @@ pipenv install fastapi-radar
 
 ## Quick Start
 
+### With SQL Database (Full Monitoring)
+
 ```python
 from fastapi import FastAPI
 from fastapi_radar import Radar
@@ -84,7 +85,7 @@ from sqlalchemy import create_engine
 app = FastAPI()
 engine = create_engine("sqlite:///./app.db")
 
-# That's it! One line to add complete monitoring 🚀
+# Full monitoring with SQL query tracking
 radar = Radar(app, db_engine=engine)
 radar.create_tables()
 
@@ -94,31 +95,62 @@ async def get_users():
     return {"users": []}
 ```
 
+### Without SQL Database (HTTP & Exception Monitoring)
+
+```python
+from fastapi import FastAPI
+from fastapi_radar import Radar
+
+app = FastAPI()
+
+# Monitor HTTP requests and exceptions only
+# Perfect for NoSQL databases, external APIs, or database-less apps
+radar = Radar(app)  # No db_engine parameter needed!
+radar.create_tables()
+
+@app.get("/api/data")
+async def get_data():
+    # Your MongoDB, Redis, or external API calls here
+    return {"data": []}
+```
+
 Access your dashboard at: **http://localhost:8000/\_\_radar/**
 
 ## Features
 
-- 🚀 **Zero Configuration** - Works with any FastAPI + SQLAlchemy app
-- 📊 **Request Monitoring** - Complete HTTP request/response capture with timing
-- 🗃️ **Database Monitoring** - SQL query logging with execution times
-- 🐛 **Exception Tracking** - Automatic exception capture with stack traces
-- ⚡ **Real-time Updates** - Live dashboard updates as requests happen
-- 🎨 **Beautiful UI** - Modern React dashboard with shadcn/ui components
+- **Zero Configuration** - Works with any FastAPI app (SQL database optional)
+- **Request Monitoring** - Complete HTTP request/response capture with timing
+- **Database Monitoring** - SQL query logging with execution times (when using SQLAlchemy)
+- **Exception Tracking** - Automatic exception capture with stack traces
+- **Real-time Updates** - Live dashboard updates as requests happen
+- **Flexible Integration** - Use with SQL, NoSQL, or no database at all
 
 ## Configuration
 
 ```python
 radar = Radar(
     app,
-    db_engine=engine,
-    dashboard_path="/__radar",  # Custom dashboard path
-    enable_in_production=False,  # Disable in production
-    capture_body=True,           # Capture request/response bodies
-    capture_headers=True,        # Capture headers
-    max_body_size=10000,        # Max body size to capture
+    db_engine=engine,            # Optional: SQLAlchemy engine for SQL query monitoring
+    dashboard_path="/__radar",   # Custom dashboard path (default: "/__radar")
+    max_requests=1000,           # Max requests to store (default: 1000)
+    retention_hours=24,          # Data retention period (default: 24)
+    slow_query_threshold=100,    # Mark queries slower than this as slow (ms)
+    capture_sql_bindings=True,   # Capture SQL query parameters
+    exclude_paths=["/health"],   # Paths to exclude from monitoring
+    theme="auto",                # Dashboard theme: "light", "dark", or "auto"
 )
 ```
 
+## What Gets Captured?
+
+- ✅ HTTP requests and responses
+- ✅ Response times and performance metrics
+- ✅ SQL queries with execution times
+- ✅ Query parameters and bindings
+- ✅ Slow query detection
+- ✅ Exceptions with stack traces
+- ✅ Request/response bodies and headers
+
 ## Contributing
 
 We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
@@ -150,10 +182,14 @@ npm run dev  # For development with hot reload
 npm run build  # To rebuild the production bundle
 ```
 
-4. Run the example app:
+4. Run the example apps:
 
 ```bash
+# Example with SQL database
 python example_app.py
+
+# Example without SQL database (NoSQL/in-memory)
+python example_nosql_app.py
 ```
 
 ## License

{fastapi_radar-0.1.3.dist-info → fastapi_radar-0.1.5.dist-info}/RECORD

@@ -1,17 +1,17 @@
-fastapi_radar/__init__.py,sha256=AIZy7tyr7kPLDQNspJTEbkCZXThWvRkm0mCaZ_icIBc,137
+fastapi_radar/__init__.py,sha256=YE_bmBBb0G-NoaqVVMA5AkkUTrryxcpdqvvt7J2K7oI,137
 fastapi_radar/api.py,sha256=xZIVW4PBAIT0ix4s58NUfwYeCEZKeViXgk9tABGeSQg,10589
 fastapi_radar/capture.py,sha256=7ozPNBcogWeILIT1YsiTg5GyIGJvIr3o2rMVJEW-RGs,3289
 fastapi_radar/middleware.py,sha256=4Jo9nX0nxtT3e9JOIP5UE490uWvAI-a61nCS_8y77rs,4964
 fastapi_radar/models.py,sha256=H2esHsTo4RZEy9GJ0I49Ob5-AS85aeO0oMWau2QrWMw,2262
-fastapi_radar/radar.py,sha256=jtRUM49CK63KoHtUAlFeDbeBE0Kh_uQL2faBcFgryY4,10256
+fastapi_radar/radar.py,sha256=UZuvLrzeBwz8TxbXLf57OVaX46N3WHfqY92XxfHMr4A,10374
 fastapi_radar/utils.py,sha256=WoL5tEH1pl6zOp0sXoPV_3UEOsIl29_xgzS0iapS10s,1515
 fastapi_radar/dashboard/dist/index.html,sha256=Q3fhImCwGAmqjZv0GYi81vJ4ELeUrOY2VS7O80UU6uU,436
 fastapi_radar/dashboard/dist/assets/index-CxIRSjZZ.js,sha256=jla8HJd6P3-vm1CYh7HLkgTys-HFOMILPH4DlFDcCxk,789553
 fastapi_radar/dashboard/dist/assets/index-DCxkDBhr.css,sha256=RLA1xEBZZaQDyJqE1rok9UTyavpMgYb4bcuRdjKhMHo,33691
-fastapi_radar-0.1.3.dist-info/licenses/LICENSE,sha256=0ga4BB6q-nqx6xlDRhtrgKrYs0HgX02PQyIzNFRK09Q,1067
+fastapi_radar-0.1.5.dist-info/licenses/LICENSE,sha256=0ga4BB6q-nqx6xlDRhtrgKrYs0HgX02PQyIzNFRK09Q,1067
 tests/__init__.py,sha256=kAWaI50iJRZ4JlAdyt7FICgm8MsloZz0ZlsmhgLXBas,31
 tests/test_radar.py,sha256=qA9iUtk6zzcsjgoxJriQngFvhHUqXmVrPcULp58sI1o,1684
-fastapi_radar-0.1.3.dist-info/METADATA,sha256=XBsKXx18Q8Rml2kwwkAYbii5dnWgS9t6XWZPe0iKg7o,4813
-fastapi_radar-0.1.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fastapi_radar-0.1.3.dist-info/top_level.txt,sha256=M-bALM-KDkiLcATq2aAx-BnG59Nv-GdFBzuzkUhiCa0,20
-fastapi_radar-0.1.3.dist-info/RECORD,,
+fastapi_radar-0.1.5.dist-info/METADATA,sha256=__ElmxMuvC9LaRntXhrSpgiJgo9WEC4gs7uRq3BICqw,5954
+fastapi_radar-0.1.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fastapi_radar-0.1.5.dist-info/top_level.txt,sha256=M-bALM-KDkiLcATq2aAx-BnG59Nv-GdFBzuzkUhiCa0,20
+fastapi_radar-0.1.5.dist-info/RECORD,,