updated documentation data with sample application

Author: nikhila05

README.rst

@@ -14,7 +14,10 @@ Source Code is available in Micropyramid Repository(https://github.com/MicroPyra
 Modules used:
 
     * Python  >= 2.6 (or Python 3.4)
-    * Django  = 1.9.6
+    * Django  = 1.11.2
+    * Django Compressor = 2.1.1
+    * Django Debug Toolbar = 1.8
+    * requests = 2.17.3
     * JQuery  >= 1.7
 
 
@@ -25,7 +28,7 @@ Installation Procedure
 
     pip install django-web-profiler
 
-    		(or)
+            (or)
 
     git clone git://github.com/micropyramid/django-web-profiler.git
 
@@ -53,13 +56,17 @@ Installation Procedure
 
     Disable 'debug_toolbar.middleware.DebugToolbarMiddleware' if you've already using it.
 
+4. Make sure that 'debug-toolbar' has enabled for your application. After installing debug toolbar, add the following details to settings.py:
 
-3. After installing/cloning, add the following details in settings file about urls,  logger names::
+    INTERNAL_IPS = ('127.0.0.1',)
+
+
+5. After installing/cloning, add the following details in settings file about urls,  logger names::
 
     URLS = ['http://stage.testsite.com/', 'http://stage.testsite.com/testing/']
 
 
-4. Add the following logger to your existing loggers::
+6. Add the following logger to your existing loggers and create a folder called 'logs' where all profiler log files are stored::
 
         'request-logging': {
             'level': 'DEBUG',
@@ -70,6 +77,24 @@ Installation Procedure
     Here file_log is a handler which contains a path where log files are stored.
 
 
+Sample Application
+==================
+
+1. Install application requirements using the following command::
+
+    pip install -r requirements.txt
+
+
+2. Load the application load using the following command::
+
+    python sandbox/manage.py loaddata sandbox/fixtures/users.json
+
+
+3. Using the following command, we can generate url statistics in production environment i.e debug=False:
+
+    python sandbox/manage.py logging_urls
+
+
 We are always looking to help you customize the whole or part of the code as you like.
 
 

docs/source/conf.py

@@ -43,7 +43,7 @@
 master_doc = 'index'
 
 # General information about the project.
-project = u'django-web-packer'
+project = u'django-web-profiler'
 copyright = u'2016, MicroPyramid'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -176,7 +176,7 @@
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'django-web-packer-doc'
+htmlhelp_basename = 'django-web-profiler-doc'
 
 
 # -- Options for LaTeX output ---------------------------------------------
@@ -196,8 +196,8 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-  ('index', 'django-web-packer.tex', u'django-web-packer Documentation',
-   u'django-web-packer', 'manual'),
+  ('index', 'django-web-profiler.tex', u'django-web-profiler Documentation',
+   u'django-web-profiler', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -226,8 +226,8 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'django-web-packer', u'django-web-packer Documentation',
-     [u'django-web-packer'], 1)
+    ('index', 'django-web-profiler', u'django-web-profiler Documentation',
+     [u'django-web-profiler'], 1)
 ]
 
 # If true, show URL addresses after external links.
@@ -240,8 +240,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'django-web-packer', u'django-web-packer Documentation',
-   u'django-web-packer', 'django-web-packer', 'One line description of project.',
+  ('index', 'django-web-profiler', u'django-web-profiler Documentation',
+   u'django-web-profiler', 'django-web-profiler', 'One line description of project.',
    'Miscellaneous'),
 ]
 

docs/source/index.rst

@@ -14,7 +14,10 @@ Source Code is available in Micropyramid Repository(https://github.com/MicroPyra
 Modules used:
 
     * Python  >= 2.6 (or Python 3.4)
-    * Django  = 1.9.6
+    * Django  = 1.11.2
+    * Django Compressor = 2.1.1
+    * Django Debug Toolbar = 1.8
+    * requests = 2.17.3
     * JQuery  >= 1.7
 
 
@@ -74,6 +77,24 @@ Installation Procedure
     Here file_log is a handler which contains a path where log files are stored.
 
 
+Sample Application
+==================
+
+1. Install application requirements using the following command::
+
+    pip install -r requirements.txt
+
+
+2. Load the application load using the following command::
+
+    python sandbox/manage.py loaddata sandbox/fixtures/users.json
+
+
+3. Using the following command, we can generate url statistics in production environment i.e debug=False:
+
+    python sandbox/manage.py logging_urls
+
+
 We are always looking to help you customize the whole or part of the code as you like.
 
 

sandbox/db.sqlite3

@@ -1,4 +1,4 @@
-Django==1.10.7
+Django==1.11.2
 django-compressor==2.1.1
 django-debug-toolbar==1.8
 django-web-profiler==0.1.2