Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/topunix/django-explain-errors
🐍 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.
https://github.com/topunix/django-explain-errors
django openai openai-api
Last synced: 4 days ago
JSON representation
🐍 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.
- Host: GitHub
- URL: https://github.com/topunix/django-explain-errors
- Owner: topunix
- License: mit
- Created: 2024-06-29T17:55:43.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2024-07-10T23:05:15.000Z (4 months ago)
- Last Synced: 2024-10-31T00:23:53.527Z (15 days ago)
- Topics: django, openai, openai-api
- Language: Python
- Homepage: https://pypi.org/project/django-explain-errors/
- Size: 16.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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)