fastapi-radar 0.1.3__tar.gz → 0.1.5__tar.gz

{fastapi_radar-0.1.3/fastapi_radar.egg-info → fastapi_radar-0.1.5}/PKG-INFO

@@ -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.5/README.md

@@ -0,0 +1,158 @@
+# 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!**
+
+## See it in Action
+
+![FastAPI Radar Dashboard Demo](./assets/demo.gif)
+
+## Installation
+
+```bash
+pip install fastapi-radar
+```
+
+Or with your favorite package manager:
+
+```bash
+# Using poetry
+poetry add fastapi-radar
+
+# Using pipenv
+pipenv install fastapi-radar
+```
+
+**Note:** The dashboard comes pre-built! No need to build anything - just install and use.
+
+## Quick Start
+
+### With SQL Database (Full Monitoring)
+
+```python
+from fastapi import FastAPI
+from fastapi_radar import Radar
+from sqlalchemy import create_engine
+
+app = FastAPI()
+engine = create_engine("sqlite:///./app.db")
+
+# Full monitoring with SQL query tracking
+radar = Radar(app, db_engine=engine)
+radar.create_tables()
+
+# Your routes work unchanged
+@app.get("/users")
+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 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,            # 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.
+
+### Development Setup
+
+For contributors who want to modify the codebase:
+
+1. Clone the repository:
+
+```bash
+git clone https://github.com/doganarif/fastapi-radar.git
+cd fastapi-radar
+```
+
+2. Install development dependencies:
+
+```bash
+pip install -e ".[dev]"
+```
+
+3. (Optional) If modifying the dashboard UI:
+
+```bash
+cd fastapi_radar/dashboard
+npm install
+npm run dev  # For development with hot reload
+# or
+npm run build  # To rebuild the production bundle
+```
+
+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
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Acknowledgments
+
+- Built with [FastAPI](https://fastapi.tiangolo.com/)
+- Dashboard powered by [React](https://react.dev/) and [shadcn/ui](https://ui.shadcn.com/)

{fastapi_radar-0.1.3 → fastapi_radar-0.1.5}/fastapi_radar/__init__.py

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

{fastapi_radar-0.1.3 → fastapi_radar-0.1.5}/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 → fastapi_radar-0.1.5/fastapi_radar.egg-info}/PKG-INFO

@@ -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 → fastapi_radar-0.1.5}/fastapi_radar.egg-info/requires.txt

@@ -2,8 +2,6 @@ fastapi>=0.68.0
 sqlalchemy>=1.4.0
 pydantic>=1.8.0
 starlette>=0.14.2
-black>=24.8.0
-httpx>=0.28.1
 
 [dev]
 pytest>=7.0.0
@@ -13,3 +11,4 @@ black>=22.0.0
 isort>=5.10.0
 flake8>=4.0.0
 mypy>=0.950
+httpx>=0.28.1

{fastapi_radar-0.1.3 → fastapi_radar-0.1.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "fastapi-radar"
-version = "0.1.3"
+version = "0.1.5"
 description = "A debugging dashboard for FastAPI applications with real-time monitoring"
 readme = "README.md"
 requires-python = ">=3.8"
@@ -31,8 +31,6 @@ dependencies = [
     "sqlalchemy>=1.4.0",
     "pydantic>=1.8.0",
     "starlette>=0.14.2",
-    "black>=24.8.0",
-    "httpx>=0.28.1",
 ]
 
 [project.urls]
@@ -49,6 +47,7 @@ dev = [
     "isort>=5.10.0",
     "flake8>=4.0.0",
     "mypy>=0.950",
+    "httpx>=0.28.1",
 ]
 
 [build-system]

{fastapi_radar-0.1.3 → fastapi_radar-0.1.5}/setup.py

@@ -9,7 +9,7 @@ long_description = (this_directory / "README.md").read_text()
 
 setup(
     name="fastapi-radar",
-    version="0.1.0",
+    version="0.1.5",
     author="Arif Dogan",
     author_email="me@arif.sh",
     description="A debugging dashboard for FastAPI applications with real-time request, database query, and exception monitoring",

fastapi_radar-0.1.3/README.md

@@ -1,121 +0,0 @@
-# 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!**
-
-## 🎯 See it in Action
-
-![FastAPI Radar Dashboard Demo](./assets/demo.gif)
-
-## Installation
-
-```bash
-pip install fastapi-radar
-```
-
-Or with your favorite package manager:
-
-```bash
-# Using poetry
-poetry add fastapi-radar
-
-# Using pipenv
-pipenv install fastapi-radar
-```
-
-**Note:** The dashboard comes pre-built! No need to build anything - just install and use.
-
-## Quick Start
-
-```python
-from fastapi import FastAPI
-from fastapi_radar import Radar
-from sqlalchemy import create_engine
-
-app = FastAPI()
-engine = create_engine("sqlite:///./app.db")
-
-# That's it! One line to add complete monitoring 🚀
-radar = Radar(app, db_engine=engine)
-radar.create_tables()
-
-# Your routes work unchanged
-@app.get("/users")
-async def get_users():
-    return {"users": []}
-```
-
-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
-
-## 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
-)
-```
-
-## Contributing
-
-We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.
-
-### Development Setup
-
-For contributors who want to modify the codebase:
-
-1. Clone the repository:
-
-```bash
-git clone https://github.com/doganarif/fastapi-radar.git
-cd fastapi-radar
-```
-
-2. Install development dependencies:
-
-```bash
-pip install -e ".[dev]"
-```
-
-3. (Optional) If modifying the dashboard UI:
-
-```bash
-cd fastapi_radar/dashboard
-npm install
-npm run dev  # For development with hot reload
-# or
-npm run build  # To rebuild the production bundle
-```
-
-4. Run the example app:
-
-```bash
-python example_app.py
-```
-
-## License
-
-This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
-
-## Acknowledgments
-
-- Built with [FastAPI](https://fastapi.tiangolo.com/)
-- Dashboard powered by [React](https://react.dev/) and [shadcn/ui](https://ui.shadcn.com/)