Description:
djangoexplainerrors 0.1
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
Install django-explain-errors by running:
pip install django-explain-errors
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:
MIDDLEWARE = [
...
'explain_errors.ExplainErrorsMiddleware',
]
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:
OPENAI_API_KEY=your_openai_api_key_here
Usage
Ensure DEBUG is set to True:
Open your settings.py file and set:
DEBUG = True
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:
# 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 file for details.
Contributing
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
Acknowledgements
Django
OpenAI
python-dotenv
License
For personal and professional use. You cannot resell or redistribute these repositories in their original state.
Customer Reviews
There are no reviews.
