aboutsummaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorAlex Gaynor2009-05-27 19:17:24 -0700
committerRob Hudson2009-05-27 19:18:28 -0700
commit1956ee540c75f9d4226f0352df5b06aae5c02703 (patch)
tree40cd6981c02dc58e0197586846f256cac07bb745 /README.rst
parent08b6a97d759e9808962cafd5a5ef3bab3642ccdb (diff)
downloaddjango-debug-toolbar-1956ee540c75f9d4226f0352df5b06aae5c02703.tar.bz2
Adding a signals panel to display list of signals and their providing arguments
and receivers. Thanks Alex Gaynor! Signed-off-by: Rob Hudson <rob@cogit8.org>
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.rst b/README.rst
index 22a89ea..c80e005 100644
--- a/README.rst
+++ b/README.rst
@@ -15,6 +15,7 @@ Currently, the following panels have been written and are working:
- GET/POST/cookie/session variable display
- Templates and context used, and their template paths
- SQL queries including time to execute and links to EXPLAIN each query
+- List of signals, their args and receivers
- Logging output via Python's built-in logging module
If you have ideas for other panels please let us know.
@@ -50,7 +51,7 @@ Installation
#. Add `debug_toolbar` to your `INSTALLED_APPS` setting so Django can find the
template files associated with the Debug Toolbar.
-
+
Alternatively, add the path to the debug toolbar templates
(``'path/to/debug_toolbar/templates'`` to your ``TEMPLATE_DIRS`` setting.)
@@ -72,6 +73,7 @@ The debug toolbar has two settings that can be set in `settings.py`:
'debug_toolbar.panels.request_vars.RequestVarsDebugPanel',
'debug_toolbar.panels.template.TemplateDebugPanel',
'debug_toolbar.panels.sql.SQLDebugPanel',
+ 'debug_toolbar.panels.signals.SignalDebugPanel',
'debug_toolbar.panels.logger.LoggingPanel',
)
@@ -96,6 +98,9 @@ The debug toolbar has two settings that can be set in `settings.py`:
provide your own method for displaying the toolbar which contains your
custom logic. This method should return True or False.
+ * `EXTRA_SIGNALS`: An array of custom signals that might be in your project,
+ defined as the python path to the signal.
+
Example configuration::
def custom_show_toolbar(request):
@@ -104,6 +109,7 @@ The debug toolbar has two settings that can be set in `settings.py`:
DEBUG_TOOLBAR_CONFIG = {
'INTERCEPT_REDIRECTS': False,
'SHOW_TOOLBAR_CALLBACK': custom_show_toolbar,
+ 'EXTRA_SIGNALS': ['myproject.signals.MySignal'],
}
TODOs and BUGS