exceptbot-drf 1.0.0__py3-none-any.whl

exceptbot/urls.py

@@ -0,0 +1,85 @@
+"""
+URL configuration for ExceptBot DRF API.
+
+Endpoints:
+    GET  /exceptbot/api/unresolved/
+    GET  /exceptbot/api/resolved/
+    GET  /exceptbot/api/settings/
+    PUT  /exceptbot/api/settings/
+    GET  /exceptbot/api/<log_id>/
+    GET  /exceptbot/api/<log_id>/error/
+    GET  /exceptbot/api/<log_id>/file/
+    POST /exceptbot/api/<log_id>/resolve/
+    POST /exceptbot/api/<log_id>/unresolve/
+    POST /exceptbot/api/<log_id>/ai/
+"""
+from django.urls import path
+
+from .views import (
+    UnresolvedExceptionListView,
+    ResolvedExceptionListView,
+    ExceptionDetailView,
+    ExceptionErrorMessageView,
+    ExceptionFileContentView,
+    MarkResolvedView,
+    MarkUnresolvedView,
+    AIRecommendationView,
+    AppSettingsView,
+)
+
+app_name = 'exceptbot'
+
+urlpatterns = [
+    # ---------- لیست‌ها ----------
+    path(
+        'api/unresolved/',
+        UnresolvedExceptionListView.as_view(),
+        name='unresolved-list',
+    ),
+    path(
+        'api/resolved/',
+        ResolvedExceptionListView.as_view(),
+        name='resolved-list',
+    ),
+
+    # ---------- تنظیمات ----------
+    path(
+        'api/settings/',
+        AppSettingsView.as_view(),
+        name='app-settings',
+    ),
+
+    # ---------- جزئیات ----------
+    path(
+        'api/<int:log_id>/',
+        ExceptionDetailView.as_view(),
+        name='exception-detail',
+    ),
+    path(
+        'api/<int:log_id>/error/',
+        ExceptionErrorMessageView.as_view(),
+        name='exception-error',
+    ),
+    path(
+        'api/<int:log_id>/file/',
+        ExceptionFileContentView.as_view(),
+        name='exception-file',
+    ),
+
+    # ---------- عملیات ----------
+    path(
+        'api/<int:log_id>/resolve/',
+        MarkResolvedView.as_view(),
+        name='mark-resolved',
+    ),
+    path(
+        'api/<int:log_id>/unresolve/',
+        MarkUnresolvedView.as_view(),
+        name='mark-unresolved',
+    ),
+    path(
+        'api/<int:log_id>/ai/',
+        AIRecommendationView.as_view(),
+        name='ai-recommendation',
+    ),
+]

exceptbot/views.py

@@ -0,0 +1,272 @@
+from rest_framework import status
+from rest_framework.views import APIView
+from rest_framework.response import Response
+from rest_framework.generics import ListAPIView, RetrieveAPIView
+
+from openai import OpenAI
+
+from .models import ExceptionLog, AppSettings
+from .permissions import IsSuperUser
+from .serializers import (
+    ExceptionLogListSerializer,
+    ExceptionLogDetailSerializer,
+    ExceptionLogResolveSerializer,
+    AppSettingsSerializer,
+)
+
+
+# ============================================================
+# GET /exceptbot/api/unresolved/
+# ============================================================
+class UnresolvedExceptionListView(ListAPIView):
+    serializer_class = ExceptionLogListSerializer
+    permission_classes = [IsSuperUser]
+
+    def get_queryset(self):
+        return ExceptionLog.objects.filter(
+            is_resolved=False
+        ).order_by('-timestamp')
+
+
+# ============================================================
+# GET /exceptbot/api/resolved/
+# ============================================================
+class ResolvedExceptionListView(ListAPIView):
+    serializer_class = ExceptionLogListSerializer
+    permission_classes = [IsSuperUser]
+
+    def get_queryset(self):
+        return ExceptionLog.objects.filter(
+            is_resolved=True
+        ).order_by('-timestamp')
+
+
+# ============================================================
+# GET /exceptbot/api/<log_id>/
+# ============================================================
+class ExceptionDetailView(RetrieveAPIView):
+    queryset = ExceptionLog.objects.all()
+    serializer_class = ExceptionLogDetailSerializer
+    permission_classes = [IsSuperUser]
+    lookup_url_kwarg = 'log_id'
+
+
+# ============================================================
+# GET /exceptbot/api/<log_id>/error/
+# ============================================================
+class ExceptionErrorMessageView(APIView):
+    permission_classes = [IsSuperUser]
+
+    def get(self, request, log_id):
+        try:
+            log = ExceptionLog.objects.get(id=log_id)
+        except ExceptionLog.DoesNotExist:
+            return Response(
+                {'detail': 'Exception log not found.'},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
+        return Response({
+            'id': log.id,
+            'exception_type': log.exception_type,
+            'full_error_message': log.full_error_message,
+        })
+
+
+# ============================================================
+# GET /exceptbot/api/<log_id>/file/
+# ============================================================
+class ExceptionFileContentView(APIView):
+    permission_classes = [IsSuperUser]
+
+    def get(self, request, log_id):
+        try:
+            log = ExceptionLog.objects.get(id=log_id)
+        except ExceptionLog.DoesNotExist:
+            return Response(
+                {'detail': 'Exception log not found.'},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
+        return Response({
+            'id': log.id,
+            'file_name': log.file_name,
+            'line_number': log.line_number,
+            'error_line_content': log.error_line_content,
+            'file_content': log.file_content,
+        })
+
+
+# ============================================================
+# POST /exceptbot/api/<log_id>/resolve/
+# ============================================================
+class MarkResolvedView(APIView):
+    permission_classes = [IsSuperUser]
+
+    def post(self, request, log_id):
+        try:
+            log = ExceptionLog.objects.get(id=log_id)
+        except ExceptionLog.DoesNotExist:
+            return Response(
+                {'detail': 'Exception log not found.'},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
+        serializer = ExceptionLogResolveSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        if log.is_resolved:
+            return Response(
+                {'detail': 'این خطا قبلاً رفع شده است.'},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+
+        log.mark_resolved(
+            user=request.user,
+            note=serializer.validated_data.get('resolution_note', ''),
+        )
+
+        return Response(
+            ExceptionLogDetailSerializer(log).data,
+            status=status.HTTP_200_OK,
+        )
+
+
+# ============================================================
+# POST /exceptbot/api/<log_id>/unresolve/
+# ============================================================
+class MarkUnresolvedView(APIView):
+    permission_classes = [IsSuperUser]
+
+    def post(self, request, log_id):
+        try:
+            log = ExceptionLog.objects.get(id=log_id)
+        except ExceptionLog.DoesNotExist:
+            return Response(
+                {'detail': 'Exception log not found.'},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
+        log.is_resolved = False
+        log.resolved_by = None
+        log.resolved_at = None
+        log.resolution_note = ''
+        log.save()
+
+        return Response(
+            ExceptionLogDetailSerializer(log).data,
+            status=status.HTTP_200_OK,
+        )
+
+
+# ============================================================
+# POST /exceptbot/api/<log_id>/ai/
+# ============================================================
+class AIRecommendationView(APIView):
+    permission_classes = [IsSuperUser]
+
+    def post(self, request, log_id):
+        try:
+            log = ExceptionLog.objects.get(id=log_id)
+        except ExceptionLog.DoesNotExist:
+            return Response(
+                {'detail': 'Exception log not found.'},
+                status=status.HTTP_404_NOT_FOUND,
+            )
+
+        app_settings = AppSettings.get_solo()
+        if not app_settings.openai_api_key:
+            return Response(
+                {'detail': 'OpenAI API key is not configured.'},
+                status=status.HTTP_400_BAD_REQUEST,
+            )
+        if log.ai_suggestion:
+            return Response({
+                'id': log.id,
+                'ai_suggestion': log.ai_suggestion,
+                'cached': True,
+            })
+        exception_information = f"""My Django application has thrown an exception.
+An exception happened in line {log.line_number} of file {log.file_name}.
+The exception type is: {log.exception_type}
+
+The content of the exception message is:
+{log.full_error_message}
+
+text
+
+The content of the file that produced the exception is:
+{log.file_content}
+
+text
+
+The specific line from the above that threw the error is:
+{log.error_line_content}
+
+text
+
+Please provide a suggestion for how to address the issue.
+"""
+
+        messages = [
+            {
+                "role": "system",
+                "content": (
+                    "You are ExceptBot. Users send you information about exceptions "
+                    "in their Django applications and you respond with useful instructions "
+                    "and code on how to fix the issue. Please answer efficiently and use "
+                    "an economy of words."
+                ),
+            },
+            {
+                "role": "user",
+                "content": exception_information,
+            },
+        ]
+
+        try:
+            client = OpenAI(api_key=app_settings.openai_api_key)
+
+            response = client.chat.completions.create(
+                model="gpt-4-1106-preview",
+                messages=messages,
+            )
+
+            log.ai_suggestion = response.choices[0].message.content
+            log.save(update_fields=['ai_suggestion'])
+
+        except Exception as exc:
+            return Response(
+                {'detail': f'AI service error: {str(exc)}'},
+                status=status.HTTP_502_BAD_GATEWAY,
+            )
+
+        return Response({
+            'id': log.id,
+            'ai_suggestion': log.ai_suggestion,
+            'cached': False,
+        })
+
+
+# ============================================================
+# GET  /exceptbot/api/settings/
+# PUT  /exceptbot/api/settings/
+# ============================================================
+class AppSettingsView(APIView):
+    permission_classes = [IsSuperUser]
+
+    def get(self, request):
+        app_settings = AppSettings.get_solo()
+        serializer = AppSettingsSerializer(app_settings)
+        return Response(serializer.data)
+
+    def put(self, request):
+        app_settings = AppSettings.get_solo()
+        serializer = AppSettingsSerializer(
+            app_settings,
+            data=request.data,
+            partial=True,
+        )
+        serializer.is_valid(raise_exception=True)
+        serializer.save()
+        return Response(serializer.data)

exceptbot_drf-1.0.0.dist-info/METADATA

@@ -0,0 +1,277 @@
+Metadata-Version: 2.4
+Name: exceptbot-drf
+Version: 1.0.0
+Summary: Exception Logger with AI Suggestions for Django REST Framework
+Author-email: Taha Zarei <tahazarei777@gmail.com>
+Maintainer-email: Taha Zarei <tahazarei777@gmail.com>
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/tahazarei777/exceptbot-drf
+Project-URL: Repository, https://github.com/tahazarei777/exceptbot-drf.git
+Project-URL: Bug Tracker, https://github.com/tahazarei777/exceptbot-drf/issues
+Project-URL: Changelog, https://github.com/tahazarei777/exceptbot-drf/blob/main/CHANGELOG.md
+Keywords: django,django-rest-framework,drf,exception,logger,error-tracking,middleware,openai,chatgpt,api
+Classifier: Development Status :: 4 - Beta
+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: Operating System :: OS Independent
+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 :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Debuggers
+Classifier: Topic :: System :: Logging
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE.md
+Requires-Dist: Django>=3.2
+Requires-Dist: djangorestframework>=3.12
+Requires-Dist: openai>=1.3.7
+Provides-Extra: dev
+Requires-Dist: build>=1.0.0; extra == "dev"
+Requires-Dist: twine>=4.0.0; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-django>=4.5.0; extra == "dev"
+Dynamic: license-file
+
+```
+# ExceptBot DRF
+
+Exception Logger with AI Suggestions for Django REST Framework.
+
+[![PyPI version](https://badge.fury.io/py/exceptbot-drf.svg)](https://pypi.org/project/exceptbot-drf/)
+[![Python](https://img.shields.io/badge/python-3.8%2B-blue)](https://www.python.org/)
+[![Django](https://img.shields.io/badge/django-3.2%2B-green)](https://www.djangoproject.com/)
+[![DRF](https://img.shields.io/badge/djangorestframework-3.12%2B-red)](https://www.django-rest-framework.org/)
+[![License](https://img.shields.io/badge/license-BSD--3--Clause-blue)](LICENSE.md)
+
+## Overview
+
+ExceptBot DRF is a Django middleware and REST API application that captures, logs, and helps resolve exceptions in Django/DRF projects. Superusers can view exceptions through REST endpoints, request AI-powered fix suggestions from OpenAI, and track resolution status.
+
+This project is a fork of [ExceptBot](https://github.com/geneffects/exceptbot) by Brian Risk, modified to support Django REST Framework APIs, custom user models, and enhanced request metadata.
+
+## Features
+
+- Automatic exception capture via Django middleware
+- Full stack trace with code snapshot of the offending file
+- File name, line number, and exact line that raised the exception
+- Request context: URL path, HTTP method, status code, IP address, user agent, and masked request body
+- Source detection (`backend`, `frontend`, `unknown`) via the `X-Client-Type` header
+- Smart deduplication: identical exceptions increment a `count` field
+- AI-powered fix suggestions via OpenAI ChatGPT
+- Resolution tracking with `is_resolved`, `resolved_by`, `resolved_at`, and `resolution_note`
+- REST API with superuser-only access
+- Singleton `AppSettings` model
+
+## Requirements
+
+- Python >= 3.8
+- Django >= 3.2
+- djangorestframework >= 3.12
+- openai >= 1.3.7
+
+## Installation
+
+```bash
+pip install exceptbot-drf
+```
+
+## Setup
+
+### 1. Add to `INSTALLED_APPS`
+
+```python
+INSTALLED_APPS = [
+    # ...
+    'rest_framework',
+    'exceptbot',
+    # ...
+]
+```
+
+### 2. Add the middleware
+
+```python
+MIDDLEWARE = [
+    # ...
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    # ...
+    'exceptbot.middleware.ExceptBotMiddleware',
+]
+```
+
+`AuthenticationMiddleware` must appear before `ExceptBotMiddleware` so that `request.user` is available.
+
+### 3. Configure DRF authentication
+
+```python
+REST_FRAMEWORK = {
+    'DEFAULT_AUTHENTICATION_CLASSES': [
+        'rest_framework.authentication.SessionAuthentication',
+        'rest_framework.authentication.TokenAuthentication',
+    ],
+}
+```
+
+### 4. Include the URLs
+
+```python
+from django.urls import path, include
+
+urlpatterns = [
+    # ...
+    path('exceptbot/', include('exceptbot.urls', namespace='exceptbot')),
+    # ...
+]
+```
+
+### 5. Run migrations
+
+```bash
+python manage.py migrate exceptbot
+```
+
+### 6. Configure settings
+
+Navigate to `/admin/exceptbot/appsettings/` and set the following fields:
+
+| Field | Description |
+| :--- | :--- |
+| `project_name` | The directory name of your project (used to locate the correct file in the traceback) |
+| `base_url` | Base URL of your site (e.g., `https://myapp.com`) |
+| `openai_api_key` | OpenAI API key |
+
+## API Endpoints
+
+| Method | Endpoint | Description |
+| :--- | :--- | :--- |
+| GET | `/exceptbot/api/unresolved/` | List unresolved exceptions |
+| GET | `/exceptbot/api/resolved/` | List resolved exceptions |
+| GET | `/exceptbot/api/<id>/` | Full exception detail |
+| GET | `/exceptbot/api/<id>/error/` | Error message and traceback |
+| GET | `/exceptbot/api/<id>/file/` | Content of the offending file |
+| POST | `/exceptbot/api/<id>/resolve/` | Mark as resolved |
+| POST | `/exceptbot/api/<id>/unresolve/` | Revert to unresolved |
+| POST | `/exceptbot/api/<id>/ai/` | Get or generate AI suggestion |
+| GET | `/exceptbot/api/settings/` | View settings |
+| PUT | `/exceptbot/api/settings/` | Update settings |
+
+All endpoints require superuser authentication.
+
+## Examples
+
+Fetch unresolved exceptions:
+
+```bash
+curl -H "Authorization: Bearer YOUR_TOKEN" \
+     http://localhost:8000/exceptbot/api/unresolved/
+```
+
+Mark an exception as resolved:
+
+```bash
+curl -X POST \
+     -H "Authorization: Bearer YOUR_TOKEN" \
+     -H "Content-Type: application/json" \
+     -d '{"resolution_note": "Fixed in commit abc123"}' \
+     http://localhost:8000/exceptbot/api/1/resolve/
+```
+
+Request an AI suggestion:
+
+```bash
+curl -X POST \
+     -H "Authorization: Bearer YOUR_TOKEN" \
+     http://localhost:8000/exceptbot/api/1/ai/
+```
+
+## Source Detection
+
+To distinguish frontend errors from backend errors, include the following header in requests:
+
+```
+X-Client-Type: frontend
+```
+
+If omitted, the default value is `backend`.
+
+## How It Works
+
+1. The middleware catches exceptions in `process_exception` and inspects the traceback.
+2. It walks the traceback in reverse to find the first frame inside the project, matched by `project_name`.
+3. It reads the offending file and stores the full source as a code snapshot.
+4. It extracts HTTP method, status code, IP address, user agent, and masked request body.
+5. Identical exceptions increment `count` instead of creating new records.
+6. Superusers query the REST API to view, analyze, and resolve exceptions.
+
+## Security
+
+- Sensitive request fields (`password`, `token`, `api_key`, `authorization`, and similar) are replaced with `***MASKED***` before being stored.
+- All endpoints are protected by the `IsSuperUser` permission class.
+- The OpenAI API key is hidden in the admin list view and only shown as a boolean.
+- Only one `AppSettings` record can exist.
+
+## Project Structure
+
+```
+exceptbot/
+├── migrations/
+├── admin.py
+├── apps.py
+├── middleware.py
+├── models.py
+├── permissions.py
+├── serializers.py
+├── urls.py
+└── views.py
+```
+
+## Contributing
+
+Issues and pull requests are welcome at:
+https://github.com/tahazarei777/exceptbot-drf
+
+## Reporting Issues
+
+Report bugs at:
+https://github.com/tahazarei777/exceptbot-drf/issues
+
+## License
+
+This project is a fork of [ExceptBot](https://github.com/geneffects/exceptbot) by Brian Risk.
+
+Original work: Copyright © 2023-present, [D.AT Analytics, LLC](https://d.at/). All rights reserved.
+
+Modifications: Copyright © 2025, Taha Zarei.
+
+Licensed under the BSD 3-Clause License. See [LICENSE.md](LICENSE.md) for details.
+Exception Logger with AI Suggestions for Django REST Framework
+```
+
+**Website:**
+```
+https://pypi.org/project/exceptbot-drf/
+```
+
+**Topics:**
+```
+django
+django-rest-framework
+drf
+exception-logger
+error-tracking
+openai
+chatgpt
+python
+middleware
+api
+```
+

exceptbot_drf-1.0.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+exceptbot/__init__.py,sha256=qpinTa2JOwKaCmaZUtKaIYyL7I-mmma7s6Aw-zn2yWU,53
+exceptbot/admin.py,sha256=Wl6ZHlHECwQG8BqdGGKTS_2BxB0BNSWouGycZpW5SeE,7657
+exceptbot/apps.py,sha256=dm-qZBaqJf9KUtque9jPOFTdTojLLwXWaAVD9w7Z2wc,224
+exceptbot/middleware.py,sha256=XmPDVBtzKj0CwRMHp8F6CmG-4HxZ3PqHj618u0HkLnY,4759
+exceptbot/models.py,sha256=F3qxNdxMNXqDVTiIu5kf_S04AsQYvb2f-rcrR6dMiBU,4588
+exceptbot/permissions.py,sha256=ifz3DSAQ3Btv23N8v5liOv_wrhqSvKFpwvB2NFyLC0k,353
+exceptbot/serializers.py,sha256=7HwGNWpaP0AvWDRvFgB7PcXRNMvj6zLUAhabvaSIrM4,1812
+exceptbot/tests.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exceptbot/urls.py,sha256=6NMAd96zoNezSvGZbV3bXQY_MIVSUBr5raBQNBm3OCs,2117
+exceptbot/views.py,sha256=dAeEXN5dOvAzQG3k0WKdwu8WMwqVyioKWEnByzjcMD8,8895
+exceptbot/migrations/0001_initial.py,sha256=vGj62lOh87tIA5E6dXyapcGUhv3qu56-yv_nMsFilCU,3916
+exceptbot/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+exceptbot_drf-1.0.0.dist-info/licenses/LICENSE.md,sha256=jCLL2JKM45eawXN10hanKHEo1VBGbMcWMH6hCpmE_QU,2388
+exceptbot_drf-1.0.0.dist-info/METADATA,sha256=-EuyI0wfelURRf9ADaP8eEleac9RQR4Rdbb0s7zGOkQ,8775
+exceptbot_drf-1.0.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+exceptbot_drf-1.0.0.dist-info/top_level.txt,sha256=KMKHsV3dV3nn3xSzh8DeAasL87GKqVPubPFvCMiedQI,10
+exceptbot_drf-1.0.0.dist-info/RECORD,,

exceptbot_drf-1.0.0.dist-info/WHEEL

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