fastapi-radar 0.1.0__tar.gz

fastapi_radar-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,105 @@
+# Contributing to FastAPI Radar
+
+Thank you for your interest in contributing to FastAPI Radar! We welcome contributions from the community.
+
+## Getting Started
+
+1. Fork the repository
+2. Clone your fork:
+
+   ```bash
+   git clone https://github.com/your-username/fastapi-radar.git
+   cd fastapi-radar
+   ```
+
+3. Create a virtual environment:
+
+   ```bash
+   python -m venv venv
+   source venv/bin/activate  # On Windows: venv\Scripts\activate
+   ```
+
+4. Install dependencies:
+
+   ```bash
+   pip install -e ".[dev]"
+   ```
+
+5. Build the dashboard:
+   ```bash
+   cd fastapi_radar/dashboard
+   npm install
+   npm run build
+   cd ../..
+   ```
+
+## Development Workflow
+
+1. Create a new branch for your feature or fix:
+
+   ```bash
+   git checkout -b feature/your-feature-name
+   ```
+
+2. Make your changes and test them with the example app:
+
+   ```bash
+   python example_app.py
+   ```
+
+3. Run tests:
+
+   ```bash
+   pytest
+   ```
+
+4. Format your code:
+
+   ```bash
+   black fastapi_radar/
+   isort fastapi_radar/
+   ```
+
+5. Submit a pull request
+
+## Code Style
+
+- Follow PEP 8
+- Use Black for formatting
+- Use isort for import sorting
+- Add type hints where appropriate
+- Write docstrings for public functions and classes
+
+## Dashboard Development
+
+The dashboard is built with React, TypeScript, and Vite:
+
+```bash
+cd fastapi_radar/dashboard
+npm run dev  # Start development server
+npm run build  # Build for production
+```
+
+## Testing
+
+- Write tests for new features
+- Ensure all tests pass before submitting PR
+- Maintain or improve code coverage
+
+## Reporting Issues
+
+- Use GitHub Issues for bug reports and feature requests
+- Provide clear reproduction steps for bugs
+- Include relevant system information
+
+## Pull Request Process
+
+1. Update documentation for any new features
+2. Ensure your branch is up to date with main
+3. Write clear commit messages
+4. Reference any related issues in your PR description
+5. Be responsive to code review feedback
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the MIT License.

fastapi_radar-0.1.0/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/MANIFEST.in

@@ -0,0 +1,7 @@
+include README.md
+include LICENSE
+include CONTRIBUTING.md
+recursive-include fastapi_radar/dashboard/dist *
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+recursive-exclude * .DS_Store

fastapi_radar-0.1.0/PKG-INFO

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

@@ -0,0 +1,120 @@
+# 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/fastapi_radar/__init__.py

@@ -0,0 +1,6 @@
+"""FastAPI Radar - Debugging dashboard for FastAPI applications."""
+
+from .radar import Radar
+
+__version__ = "0.1.0"
+__all__ = ["Radar"]