exceptbot-drf 1.0.0__tar.gz

exceptbot_drf-1.0.0/LICENSE.md

@@ -0,0 +1,49 @@
+# License
+
+Copyright © 2023-present, [D.AT Analytics, LLC](https://d.at/).
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---
+
+## Modifications
+
+This project is a fork of [ExceptBot](https://github.com/geneffects/exceptbot),
+originally created by Brian Risk and D.AT Analytics, LLC.
+
+Modifications Copyright © 2025, Taha Zarei.
+
+The following changes were made to the original work:
+
+- Converted HTML views to Django REST Framework API endpoints
+- Replaced `auth.User` with `settings.AUTH_USER_MODEL` for custom user model support
+- Added new model fields: `http_method`, `status_code`, `source`, `ip_address`, `user_agent`, `request_data`, `resolution_note`
+- Added source detection via the `X-Client-Type` header
+- Added sensitive data masking for request bodies
+- Added singleton pattern for `AppSettings` with `get_solo()` method
+- Added `mark_resolved()` method to `ExceptionLog`
+- Removed form-based UI and HTML templates

exceptbot_drf-1.0.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE.md
+recursive-include exceptbot/migrations *.py

exceptbot_drf-1.0.0/PKG-INFO

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

@@ -0,0 +1,234 @@
+```
+# 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/exceptbot/__init__.py

@@ -0,0 +1 @@
+default_app_config = 'exceptbot.apps.ExceptBotConfig'