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

[Chris McDonough]

Author: Chris McDonough <chrism at agendaless.com>
Date: Thu Jun 12 00:12:29 2008
New Revision: 1078

Log:
Prep for trial PyPI release (canary for others).


Modified:
   repoze.profile/trunk/CHANGES.txt
   repoze.profile/trunk/README.txt
   repoze.profile/trunk/setup.py

Modified: repoze.profile/trunk/CHANGES.txt
==============================================================================
--- repoze.profile/trunk/CHANGES.txt	(original)
+++ repoze.profile/trunk/CHANGES.txt	Thu Jun 12 00:12:29 2008
@@ -1,3 +1,7 @@
+repoze.profile 0.5 (2008-06-11)
+
+  - Initial PyPI release.
+
 repoze.profile 0.4 (2008-05-07)
 
   - Remove dependency-link to http://dist.repoze.org to prevent

Modified: repoze.profile/trunk/README.txt
==============================================================================
--- repoze.profile/trunk/README.txt	(original)
+++ repoze.profile/trunk/README.txt	Thu Jun 12 00:12:29 2008
@@ -2,35 +2,31 @@
 =====================
 
 This package provides a WSGI middleware component which aggregates
-profiling data across *all* requests to the WSGI application.
+profiling data across *all* requests to the WSGI application.  It
+provides a web GUI for viewing profiling data.
 
 Installation
 ------------
 
 Install using setuptools, e.g. (within a virtualenv)::
 
- $ bin/easy_install -d http://dist.repoze.org/ repoze.profile
+ $ easy_install repoze.profile
 
-Configuration
--------------
+Configuration via Python
+------------------------
 
-Wire the middleware into a pipeline in your Paste configuration::
+Wire up the middleware in your application::
 
- [filter:profile]
- use = egg:repoze.profile#profile
- log_filename = myapp.profile
- discard_first_request = true
- path = /__profile__
- flush_at_shutdown = true
- ...
-
- [pipeline:main]
- pipeline = egg:Paste#cgitb
-            egg:Paste#httpexceptions
-            profile
-            myapp
+ from repoze.profile.profiler import AccumulatingProfileMiddleware
+ middleware = AccumulatingProfileMiddleware(
+                app,
+                log_filename='/foo/bar.log',
+                discard_first_request=True,
+                flush_at_shutdown=True,
+                path='/__profile__'
+               )
 
-The configuration options are as follows:
+The configuration options are as follows::
 
  - ``log_filename`` is the name of the file to which the accumulated
    profiler statistics are logged.
@@ -41,13 +37,44 @@
    initializations which distort measurement of the application's
    normal performance.
 
- - ``path`` is the URL path to the profiler UI.  It defaults to
-   ``/__profile__``.
-
  - If ``flush_at_shutdown`` is true (the default), profiling data will
    be deleted when the middleware instance disappears (via its
    __del__).  If it's false, profiling data will persist across
    application restarts.
 
+ - ``path`` is the URL path to the profiler UI.  It defaults to
+   ``/__profile__``.
+
+Once you have some profiling data, you can visit ``path`` in your
+browser to see a user interface displaying profiling statistics
+(e.g. ``http://localhost:8080/__profile__``).
+
+Configuration via Paste
+-----------------------
+
+Wire the middleware into a pipeline in your Paste configuration, for
+example::
+
+ [filter:profile]
+ use = egg:repoze.profile#profile
+ log_filename = myapp.profile
+ discard_first_request = true
+ path = /__profile__
+ flush_at_shutdown = true
+ ...
+
+ [pipeline:main]
+ pipeline = egg:Paste#cgitb
+            egg:Paste#httpexceptions
+            profile
+            myapp
+
 Once you have some profiling data, you can visit ``path`` in your
 browser to see a user interface displaying profiling statistics.
+
+Reporting Bugs / Development Versions
+-------------------------------------
+
+Visit http://bugs.repoze.org to report bugs.  Visit
+http://svn.repoze.org to download development or tagged versions.
+

Modified: repoze.profile/trunk/setup.py
==============================================================================
--- repoze.profile/trunk/setup.py	(original)
+++ repoze.profile/trunk/setup.py	Thu Jun 12 00:12:29 2008
@@ -12,7 +12,7 @@
 #
 ##############################################################################
 
-__version__ = '0.4'
+__version__ = '0.5'
 
 import os
 
@@ -23,13 +23,14 @@
 
 here = os.path.abspath(os.path.dirname(__file__))
 README = open(os.path.join(here, 'README.txt')).read()
+CHANGES = open(os.path.join(here, 'CHANGES.txt')).read()
 
 setup(name='repoze.profile',
       version=__version__,
       description='Aggregate profiling for WSGI requests',
-      long_description=README,
+      long_description=README + '\n\n' + CHANGES,
       classifiers=[
-        "Development Status :: 1 - Planning",
+        "Development Status :: 4 - Beta",
         "Intended Audience :: Developers",
         "Programming Language :: Python",
         "Topic :: Internet :: WWW/HTTP",