Skip to content
This repository was archived by the owner on Jan 7, 2022. It is now read-only.

Commit 048591d

Browse files
committed
updated documentation data
1 parent 9352573 commit 048591d

File tree

3 files changed

+36
-14
lines changed

3 files changed

+36
-14
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ install:
88
- pip install coveralls
99

1010
script:
11-
- coverage run --source=testapp sandbox/manage.py test
11+
- coverage run --source=testingapp sandbox/manage.py test
1212

1313
after_success:
1414
coveralls

README.rst

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,23 @@ Installation Procedure
3737

3838
INSTALLED_APPS = [
3939
'..................',
40-
'django-web-profiler',
40+
'compressor',
41+
'debug_toolbar',
42+
'django_web_profiler',
4143
'..................'
4244
]
4345

46+
3. Add 'django_web_profiler.middleware.DebugLoggingMiddleware' to your project middlewares:
47+
48+
MIDDLEWARE = [
49+
'..................',
50+
'django_web_profiler.middleware.DebugLoggingMiddleware'
51+
'..................'
52+
]
53+
54+
Disable 'debug_toolbar.middleware.DebugToolbarMiddleware' if you've already using it.
55+
56+
4457
3. After installing/cloning, add the following details in settings file about urls, logger names::
4558

4659
URLS = ['http://stage.testsite.com/', 'http://stage.testsite.com/testing/']

docs/source/index.rst

Lines changed: 21 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Installation Procedure
2525

2626
pip install django-web-profiler
2727

28-
(or)
28+
(or)
2929

3030
git clone git://github.com/micropyramid/django-web-profiler.git
3131

@@ -37,16 +37,33 @@ Installation Procedure
3737

3838
INSTALLED_APPS = [
3939
'..................',
40-
'django-web-profiler',
40+
'compressor',
41+
'debug_toolbar',
42+
'django_web_profiler',
4143
'..................'
4244
]
4345

44-
3. After installing/cloning, add the following details in settings file about urls, logger names::
46+
3. Add 'django_web_profiler.middleware.DebugLoggingMiddleware' to your project middlewares:
47+
48+
MIDDLEWARE = [
49+
'..................',
50+
'django_web_profiler.middleware.DebugLoggingMiddleware'
51+
'..................'
52+
]
53+
54+
Disable 'debug_toolbar.middleware.DebugToolbarMiddleware' if you've already using it.
55+
56+
4. Make sure that 'debug-toolbar' has enabled for your application. After installing debug toolbar, add the following details to settings.py:
57+
58+
INTERNAL_IPS = ('127.0.0.1',)
59+
60+
61+
5. After installing/cloning, add the following details in settings file about urls, logger names::
4562

4663
URLS = ['http://stage.testsite.com/', 'http://stage.testsite.com/testing/']
4764

4865

49-
4. Add the following logger to your existing loggers::
66+
6. Add the following logger to your existing loggers and create a folder called 'logs' where all profiler log files are stored::
5067

5168
'request-logging': {
5269
'level': 'DEBUG',
@@ -57,14 +74,6 @@ Installation Procedure
5774
Here file_log is a handler which contains a path where log files are stored.
5875

5976

60-
Features:
61-
=========
62-
63-
* Logs debug toolbar statistics of a urls into a database in a development environment.
64-
* Logs statistics of a urls into a database in a production environment.
65-
* Provides a basic UI to display production, developement url statistics.
66-
67-
6877
We are always looking to help you customize the whole or part of the code as you like.
6978

7079

0 commit comments

Comments
 (0)