django-explain-errors 0.1__py3-none-any.whl

django_explain_errors-0.1.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mike ☕
+
+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.

django_explain_errors-0.1.dist-info/METADATA

@@ -0,0 +1,106 @@
+Metadata-Version: 2.1
+Name: django-explain-errors
+Version: 0.1
+Summary: Django middleware that captures errors and exceptions, sends them to OpenAI for a detailed explanation, and prints the explanation to stdout when debug mode is enabled
+Home-page: https://github.com/topunix/django-explain-errors
+Author: topunix
+Author-email: topunixguy@gmail.com
+License: MIT
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 2.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.5
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Topic :: Internet :: WWW/HTTP
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django >=2
+
+# Django Explain Errors Middleware
+
+This Django middleware captures errors and exceptions, sends them to OpenAI for explanation, and prints the explanation to stdout when debug mode is enabled. It uses an environment variable to securely manage the OpenAI API key.
+
+## Features
+
+- Captures Django errors and exceptions
+- Uses OpenAI to explain the error
+- Securely manages the OpenAI API key using environment variables
+
+## Installation
+
+1. Install django-explain-errors by running:
+```bash
+pip install django-explain-errors
+```
+
+2. **Add the middleware to your Django project**:
+
+   - Open your `settings.py` file and add the middleware to the `MIDDLEWARE` list. Ensure that the middleware is added last in the list: 
+
+     ```python
+     MIDDLEWARE = [
+         ...
+         'explain_errors.ExplainErrorsMiddleware',
+     ]
+     ```
+
+4. **Set up environment variables**:
+
+   - Create a `.env` file in your project’s root directory and add your OpenAI API key. Alternatively, you can list the API key in `settings.py`:
+
+     ```plaintext
+     OPENAI_API_KEY=your_openai_api_key_here
+     ```
+
+## Usage
+
+1. **Ensure DEBUG is set to True**:
+
+   Open your `settings.py` file and set:
+
+   ```python
+   DEBUG = True
+   ```
+
+2. **Trigger an error in your Django application**:
+
+   The middleware will capture the error, send it to OpenAI for explanation, and print the explanation to stdout.
+
+## Example
+
+Here is an example of how to use the middleware in a Django project:
+
+```python
+# settings.py
+
+DEBUG = True
+
+MIDDLEWARE = [
+    ...
+    'explain_errors.ExplainErrorsMiddleware',
+]
+
+# .env
+
+OPENAI_API_KEY=your_openai_api_key_here
+```
+
+When an error occurs, you will see an explanation printed to stdout.
+
+## License
+
+This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.
+
+## Contributing
+
+Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
+
+## Acknowledgements
+
+- [Django](https://www.djangoproject.com/)
+- [OpenAI](https://www.openai.com/)
+- [python-dotenv](https://github.com/theskumar/python-dotenv)

django_explain_errors-0.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+explain_errors/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+explain_errors/middleware.py,sha256=DJYGw0OGgPTXJIOx-O2KlnSxUgisGmzV6GhF2UN7w24,2389
+tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+tests/test_middleware.py,sha256=rTul8ZtFgRkkepNFRXSU1X521GgNpk3TTXFMCi3ERHQ,908
+django_explain_errors-0.1.dist-info/LICENSE,sha256=Kxbs99ohpmwKsq9TsJYyN53NwFuDQrgXtl9hfUtwGb8,1065
+django_explain_errors-0.1.dist-info/METADATA,sha256=VFEZmEQdXoIcjAC5hes6WxlTmIp2Vv4arB-RM8seTY8,2994
+django_explain_errors-0.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+django_explain_errors-0.1.dist-info/top_level.txt,sha256=bnMY4uDHGAV4sTjpJghE8sf1Ay5ezERJEaXX6Oz7DFI,21
+django_explain_errors-0.1.dist-info/RECORD,,

django_explain_errors-0.1.dist-info/WHEEL

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

django_explain_errors-0.1.dist-info/top_level.txt

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

explain_errors/middleware.py

@@ -0,0 +1,63 @@
+from openai import OpenAI
+import os
+import traceback
+from dotenv import load_dotenv
+from django.conf import settings
+from django.http import JsonResponse
+
+
+class ExplainErrorsMiddleware:
+    def __init__(self, get_response):
+        self.get_response = get_response
+        if settings.DEBUG:
+            # Load environment variables from .env file
+            load_dotenv()
+            # Get the OpenAI API key from environment variable
+            openai_api_key = os.getenv("OPENAI_API_KEY", getattr(settings, 'OPENAI_API_KEY', None))
+            if not openai_api_key:
+                raise ValueError("OpenAI API key not found. Please set the OPENAI_API_KEY environment variable.")
+
+            self.openai_client = OpenAI(
+                api_key=openai_api_key,
+            )
+            self.api_called = False  # Flag to track API call
+
+    def __call__(self, request):
+        try:
+            response = self.get_response(request)
+        except Exception as e:
+            self.process_exception(request, e)
+        return None
+
+    def process_exception(self, request, exception):
+
+        if settings.DEBUG and not self.api_called:
+            # Get the exception traceback
+            tb = traceback.format_exc()
+
+            # Construct the prompt
+            prompt = f"Explain the following Django error in simple terms:\n\n{tb}"
+
+            try:
+ 		# Call OpenAI API
+                response = self.openai_client.chat.completions.create(
+                    model="gpt-3.5-turbo",
+                    messages=[
+                        {"role": "system", "content": "You are a helpful assistant."},
+                        {"role": "user", "content": prompt}
+                    ],
+                    max_tokens=150
+                )
+                explanation = response.choices[0].message.content
+
+                # Print the explanation to stdout
+                print("Error Explanation by OpenAI:\n", explanation)
+                self.api_called = True # Set flag after the call`
+
+            except Exception as e:
+                # In case of any issues with the OpenAI API call, print an error message
+                print("Failed to get an explanation from OpenAI:", e)
+
+            # Optionally, you can return a custom error response
+            return JsonResponse({"error": "An error occurred.", "message": explanation}, status=500)
+        return None

tests/test_middleware.py

@@ -0,0 +1,27 @@
+import json
+from django.http import JsonResponse
+from django.test import SimpleTestCase, RequestFactory
+from explain_errors.middleware import ExplainErrorsMiddleware
+
+class ExplainErrorsMiddlewareTest(SimpleTestCase):
+
+  def test_process_exception_with_error(self):
+    # Simulate an exception
+    exception = Exception("Test Exception")
+
+    # Create a mock request object using RequestFactory
+    factory = RequestFactory()
+    request = factory.get('/')
+
+    # Create the middleware (no need for settings)
+    middleware = ExplainErrorsMiddleware(lambda request: None)
+
+    # Call process_exception
+    response = middleware.process_exception(request, exception)
+
+    self.assertIsInstance(response, JsonResponse)
+    self.assertEqual(response.status_code, 500)
+    response_json = json.loads(response.content)
+
+    # Check if "error" key is in the response JSON
+    self.assertIn("error", response_json)