Metadata-Version: 2.4
Name: drf-inspector
Version: 0.1.0
Summary: A comprehensive Django app that provides visualization and analysis of your DRF backend.
Home-page: https://github.com/codewithubaid1/drf-inspecotor
Author: DRF Inspector Contributors
Author-email: your.email@example.com
License: MIT
Keywords: django,djangorestframework,drf,api,inspector,visualizerarchitecture,backend,django-rest-framework,drfvisualizer,drf_inspector,drf-visualizer
Classifier: Environment :: Web Environment
Classifier: Framework :: Django
Classifier: Framework :: Django :: 3.2
Classifier: Framework :: Django :: 4.0
Classifier: Framework :: Django :: 4.1
Classifier: Framework :: Django :: 4.2
Classifier: Framework :: Django :: 5.0
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
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: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: Django>=3.2
Requires-Dist: djangorestframework>=3.12
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

# DRF Inspector

DRF Inspector is a comprehensive Django app that provides visualization and analysis of your Django REST Framework (DRF) backend architecture. 
It includes tools for analyzing URLs, models, serializers, views, security, and query optimization, making it easier to understand, document, and optimize your API.

## Features
- **URL Analysis**: View all your API endpoints, methods, and associated views.
- **Model Visualization**: Auto-generate graphs of your database models and their relationships.
- **Serializer Inspection**: Inspect serializers and their nested fields/relationships.
- **View Analysis**: Analyze views for authentication, permissions, pagination, and more.
- **Security Audit**: Identify endpoints lacking proper authentication, permission, or throttling.
- **Query Optimization**: Detect N+1 query issues and get suggestions for `select_related` and `prefetch_related`.
- **Exporting**: Export your architecture as JSON or Markdown.

## Quick Start

1. Install the package:
   ```bash
   pip install drf-inspector
   ```

2. Add `"drf_inspector"` to your `INSTALLED_APPS` setting like this:
   ```python
   INSTALLED_APPS = [
       ...
       "drf_inspector",
   ]
   ```

3. Include the drf_inspector URLconf in your project `urls.py` like this:
   ```python
   from django.urls import path, include

   urlpatterns = [
       ...
       path("drf-inspector/", include("drf_inspector.urls")),
   ]
   ```

4. Visit `http://127.0.0.1:8000/drf-inspector/` to view the dashboard.

## License
MIT License
