Skip to content

Commit 5c3e9b7

Browse files
committed
Update readme
1 parent fa11ab2 commit 5c3e9b7

File tree

1 file changed

+27
-35
lines changed

1 file changed

+27
-35
lines changed

README.md

Lines changed: 27 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,20 @@
22

33
Extensions for Django MongoDB Backend
44

5+
## Installation
6+
7+
```bash
8+
pip install django-mongodb-extensions
9+
```
10+
511
## Extensions
612

7-
### MQL Panel for Django Debug Toolbar
13+
### MQL Panel
814

9-
The first extension is the **MQL Panel** for
10-
[django-debug-toolbar](https://github.com/jazzband/django-debug-toolbar).
11-
This panel provides detailed insights into MongoDB queries executed during a
12-
request, similar to how the SQL panel works for relational databases.
15+
This panel for
16+
[Django Debug Toolbar](https://github.com/jazzband/django-debug-toolbar)
17+
provides insights into MongoDB queries executed during a request
18+
similar to how the SQL panel works for relational databases.
1319

1420
**Features:**
1521

@@ -20,31 +26,17 @@ request, similar to how the SQL panel works for relational databases.
2026
- Color-coded query grouping for easy identification
2127
- Detailed query statistics and performance metrics
2228

23-
## Installation
24-
25-
### Requirements
29+
#### Configure the MQL Panel
2630

27-
- [django-mongodb-backend](https://github.com/mongodb-labs/django-mongodb-backend)
28-
- [django-debug-toolbar](https://github.com/jazzband/django-debug-toolbar)
29-
30-
First, install and configure django-debug-toolbar by following their
31+
First, install and configure Django Debug Toolbar by following their
3132
[installation instructions](https://django-debug-toolbar.readthedocs.io/en/latest/installation.html).
3233

33-
### Install the Package
34-
35-
```bash
36-
pip install django-mongodb-extensions
37-
```
38-
39-
### Configure the MQL Panel
40-
4134
1. **Add to `INSTALLED_APPS`** in your Django settings:
4235

4336
```python
4437
INSTALLED_APPS = [
4538
# ...
46-
'debug_toolbar',
47-
'django_mongodb_extensions',
39+
"django_mongodb_extensions",
4840
# ...
4941
]
5042
```
@@ -53,20 +45,20 @@ INSTALLED_APPS = [
5345

5446
```python
5547
DEBUG_TOOLBAR_PANELS = [
56-
'debug_toolbar.panels.history.HistoryPanel',
57-
'debug_toolbar.panels.versions.VersionsPanel',
58-
'debug_toolbar.panels.timer.TimerPanel',
59-
'debug_toolbar.panels.settings.SettingsPanel',
60-
'debug_toolbar.panels.headers.HeadersPanel',
61-
'debug_toolbar.panels.request.RequestPanel',
48+
"debug_toolbar.panels.history.HistoryPanel",
49+
"debug_toolbar.panels.versions.VersionsPanel",
50+
"debug_toolbar.panels.timer.TimerPanel",
51+
"debug_toolbar.panels.settings.SettingsPanel",
52+
"debug_toolbar.panels.headers.HeadersPanel",
53+
"debug_toolbar.panels.request.RequestPanel",
6254
# Add this:
63-
'django_mongodb_extensions.mql_panel.MQLPanel',
64-
'debug_toolbar.panels.templates.TemplatesPanel',
65-
'debug_toolbar.panels.staticfiles.StaticFilesPanel',
66-
'debug_toolbar.panels.cache.CachePanel',
67-
'debug_toolbar.panels.signals.SignalsPanel',
68-
'debug_toolbar.panels.redirects.RedirectsPanel',
69-
'debug_toolbar.panels.profiling.ProfilingPanel',
55+
"django_mongodb_extensions.mql_panel.MQLPanel",
56+
"debug_toolbar.panels.templates.TemplatesPanel",
57+
"debug_toolbar.panels.staticfiles.StaticFilesPanel",
58+
"debug_toolbar.panels.cache.CachePanel",
59+
"debug_toolbar.panels.signals.SignalsPanel",
60+
"debug_toolbar.panels.redirects.RedirectsPanel",
61+
"debug_toolbar.panels.profiling.ProfilingPanel",
7062
]
7163
```
7264

0 commit comments

Comments
 (0)