[Repoze-checkins] r695 - repoze.profile/trunk

[Tres Seaver]

Author: Tres Seaver <tseaver at palladion.com>
Date: Fri Feb 15 17:22:38 2008
New Revision: 695

Log:
Prep 9.1 release.

Modified:
   repoze.profile/trunk/README.txt
   repoze.profile/trunk/TODO.txt

Modified: repoze.profile/trunk/README.txt
==============================================================================
--- repoze.profile/trunk/README.txt	(original)
+++ repoze.profile/trunk/README.txt	Fri Feb 15 17:22:38 2008
@@ -1,4 +1,42 @@
 repoze.profile README
+=====================
+
+This package provides a WSGI middleware component which aggregates
+profiling data across *all* requests to the WSGI application.
+
+Installation
+------------
+
+Install using setuptools, e.g. (within a virtualenv)::
+
+ $ bin/easy_install -d http://dist.repoze.org/ repoze.profile
+
+Configuration
+-------------
+
+Wire the middleware into a pipeline in your Paste configuration::
+
+ [filter:profile]
+ use = egg:repoze.profile#profile
+ log_filename = myapp.profile
+ discard_first_request = true
+
+ ...
+
+ [pipeline:main]
+ pipeline = egg:Paste#cgitb
+            egg:Paste#httpexceptions
+            profile
+            myapp
+
+The configuration options are as follows:
+
+ - ``log_filename`` is the name of the file to which the accumulated
+   profiler statistics are logged.
+
+ - If ``discard_first_request`` to true (the default), then the
+   middleware discards the statistics for the first request:  the
+   rationale is that there are a bunch of lazy / "first time"
+   initializations which distort measurement of the application's
+   normal performance.
 
-  This package provides a WSGI middleware component which aggregates
-  profiling data across *all* requests to the WSGI application.

Modified: repoze.profile/trunk/TODO.txt
==============================================================================
--- repoze.profile/trunk/TODO.txt	(original)
+++ repoze.profile/trunk/TODO.txt	Fri Feb 15 17:22:38 2008
@@ -1 +1,4 @@
-- [_] Package up the profile component into an egg.
+- [x] Package up the profile component into an egg.
+
+- [_] Rip off the Zope2 control panel profiler view, to display
+      "pretty" stats in the browser.