fastapi-radar 0.1.0__py3-none-any.whl

fastapi_radar-0.1.0.dist-info/METADATA

@@ -0,0 +1,165 @@
+Metadata-Version: 2.4
+Name: fastapi-radar
+Version: 0.1.0
+Summary: A debugging dashboard for FastAPI applications with real-time monitoring
+Home-page: https://github.com/doganarif/fastapi-radar
+Author: Arif Dogan
+Author-email: Arif Dogan <me@arif.sh>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/doganarif/fastapi-radar
+Project-URL: Bug Reports, https://github.com/doganarif/fastapi-radar/issues
+Project-URL: Source, https://github.com/doganarif/fastapi-radar
+Keywords: fastapi,debugging,monitoring,dashboard,development-tools
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Framework :: FastAPI
+Classifier: Topic :: Software Development :: Debuggers
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+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"
+Requires-Dist: uvicorn[standard]>=0.15.0; extra == "dev"
+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"
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# FastAPI Radar 🛰️
+
+[![Python Version](https://img.shields.io/badge/python-3.8%2B-blue.svg)](https://www.python.org/downloads/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-0.68.0%2B-green.svg)](https://fastapi.tiangolo.com)
+[![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.**
+
+## 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")
+
+# Initialize Radar - automatically adds middleware and mounts dashboard
+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
+
+## Screenshots
+
+<!-- Add screenshots here -->
+
+## 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/)

fastapi_radar-0.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+fastapi_radar/__init__.py,sha256=AIZy7tyr7kPLDQNspJTEbkCZXThWvRkm0mCaZ_icIBc,137
+fastapi_radar/api.py,sha256=P0QdP7qhXcqtzxnXpvSAST8IDXO0x_5UtD1vuZKyu9o,9614
+fastapi_radar/capture.py,sha256=JtX3fsPm_lDe4LRNy1ZaDgPqynL1XJRQUd1DNREUbc4,3279
+fastapi_radar/middleware.py,sha256=FDWXDf4fNT9AuUqvQm-tBXQi2AeM50UidHICMpIXHNI,4954
+fastapi_radar/models.py,sha256=H2esHsTo4RZEy9GJ0I49Ob5-AS85aeO0oMWau2QrWMw,2262
+fastapi_radar/radar.py,sha256=OK0ZzlkXjEAHjN4fVIVlS5TMpjJAH3JREQrSP_QGZrM,10132
+fastapi_radar/utils.py,sha256=WoL5tEH1pl6zOp0sXoPV_3UEOsIl29_xgzS0iapS10s,1515
+fastapi_radar/dashboard/dist/index.html,sha256=InLUEQlim0Ma0_6Aeyu_r40fGJwTFq_al22hNFEvm5k,436
+fastapi_radar/dashboard/dist/assets/index-BK3IXW8U.css,sha256=gurWj_xAsHtY2MJFbL7AqlJFwoaq6Bzji9PDugZmVS8,31201
+fastapi_radar/dashboard/dist/assets/index-DS-t-RQ1.js,sha256=KExks9YmUPtGj6_XR868GulBEpgx0-Q8OBkbfyEVMmI,472628
+fastapi_radar-0.1.0.dist-info/licenses/LICENSE,sha256=0ga4BB6q-nqx6xlDRhtrgKrYs0HgX02PQyIzNFRK09Q,1067
+tests/__init__.py,sha256=kAWaI50iJRZ4JlAdyt7FICgm8MsloZz0ZlsmhgLXBas,31
+tests/test_radar.py,sha256=-j9H8kHWp6cg09jo_WHEZxgqXwTeN78sLwLrunjFG9c,1698
+fastapi_radar-0.1.0.dist-info/METADATA,sha256=tZAyuSCn9qKZRO-rm9hvSEOUHFEhn0yd6Z4j3uN-E1g,4829
+fastapi_radar-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fastapi_radar-0.1.0.dist-info/top_level.txt,sha256=M-bALM-KDkiLcATq2aAx-BnG59Nv-GdFBzuzkUhiCa0,20
+fastapi_radar-0.1.0.dist-info/RECORD,,

fastapi_radar-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

fastapi_radar-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Arif Dogan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

fastapi_radar-0.1.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+fastapi_radar
+tests

tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for FastAPI Radar."""

tests/test_radar.py

@@ -0,0 +1,66 @@
+"""Test suite for FastAPI Radar."""
+
+import pytest
+from fastapi import FastAPI
+from fastapi.testclient import TestClient
+from sqlalchemy import create_engine
+
+from fastapi_radar import Radar
+
+
+def test_radar_initialization():
+    """Test that Radar can be initialized with a FastAPI app."""
+    app = FastAPI()
+    engine = create_engine("sqlite:///:memory:")
+
+    radar = Radar(app, db_engine=engine)
+    assert radar is not None
+    assert radar.app == app
+    assert radar.db_engine == engine
+
+
+def test_radar_creates_tables():
+    """Test that Radar can create necessary database tables."""
+    app = FastAPI()
+    engine = create_engine("sqlite:///:memory:")
+
+    radar = Radar(app, db_engine=engine)
+    radar.create_tables()
+
+    # Tables should be created without errors
+    assert True
+
+
+def test_dashboard_mounted():
+    """Test that the dashboard is mounted at the correct path."""
+    app = FastAPI()
+    engine = create_engine("sqlite:///:memory:")
+
+    radar = Radar(app, db_engine=engine)
+    radar.create_tables()
+
+    client = TestClient(app)
+
+    # Dashboard should be accessible
+    response = client.get("/__radar")
+    # Should return HTML or redirect
+    assert response.status_code in [200, 307]
+
+
+def test_middleware_captures_requests():
+    """Test that middleware captures HTTP requests."""
+    app = FastAPI()
+    engine = create_engine("sqlite:///:memory:")
+
+    radar = Radar(app, db_engine=engine)
+    radar.create_tables()
+
+    @app.get("/test")
+    async def test_endpoint():
+        return {"message": "test"}
+
+    client = TestClient(app)
+    response = client.get("/test")
+
+    assert response.status_code == 200
+    assert response.json() == {"message": "test"}