Commits

Hideo Hattori  committed 4b9ef49

rename for bitbucket.org

  • Participants
  • Parent commits c2b62bb

Comments (0)

Files changed (2)

+About
+=====
+
+This script is converted to HTML file from Python's profile,
+Profile and hotshot profiling data.
+inspired by `Devel::NYTProf`_ (Perl Module)
+
+sample data (`pystone hotshot linetimings`_ `pystone cProfile`_)
+
+.. _`pystone hotshot linetimings`: http://www.hexacosa.net/pyprof2html/pystone-line_html/
+.. _`pystone cProfile`: http://www.hexacosa.net/pyprof2html/pystone_html/
+.. _`Devel::NYTProf`: http://search.cpan.org/dist/Devel-NYTProf/
+
+Install
+=======
+
+used to easy_install::
+
+  $ easy_install pyprof2html
+
+
+Require
+=======
+
+Require `Jinja2`_ module.
+
+.. _`Jinja2`: http://pypi.python.org/pypi/Jinja2/
+
+Ubuntu
+------
+
+python-profiler (Ubuntu Package)
+
+installed to::
+
+  $ easy_install jinja2
+
+or::
+
+  $ sudo apt-get intall python-jinja2
+  $ sudo apt-get intall python-profiler
+
+
+Usage
+=====
+
+basic usage::
+
+  $ python -m cProfile -o PROFILE_DATA USER_SCRIPT.py
+  $ pyprof2html PROFILE_DATA
+  $ ls
+  html
+
     name='pyprof2html',
     version=pyprof2html.__version__,
     description="Python cProfile and hotshot profile's data to HTML Converter",
-    long_description=open("README").read(),
+    long_description=open("README.rst").read(),
     license='New BSD License',
     author='Hideo Hattori',
     author_email='hhatto.jp@gmail.com',