Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Cosmetic update

  • Loading branch information...
commit 42182a7ca89015ab5764dbf5d4d674facfa5cca5 1 parent 9cfe0e8
@fabianp authored
Showing with 12 additions and 14 deletions.
  1. +10 −13 README.rst
  2. +2 −1  setup.py
View
23 README.rst
@@ -69,19 +69,18 @@ with respect to the last one. The last column (*Line Contents*) prints
the code that has been profiled.
-====
-API
-====
-
+=====
+ API
+=====
memory_profiler exposes a number of functions to be used in third-party
code.
-`memory_usage(proc=-1, interval=.1, timeout=None)` returns the memory usage
-over a time interval. The first argument, `proc` represents what
+``memory_usage(proc=-1, interval=.1, timeout=None)`` returns the memory usage
+over a time interval. The first argument, ``proc`` represents what
should be monitored. This can either be the PID of a process (not
necessarily a Python program), a string containing some python code to
-be evaluated or a tuple (f, args, kw) containing a function and its
-arguments to be evaluated as f(*args, **kw). For example::
+be evaluated or a tuple ``(f, args, kw)`` containing a function and its
+arguments to be evaluated as ``f(*args, **kw)``. For example::
>>> # define a simple function
@@ -98,10 +97,9 @@ arguments to be evaluated as f(*args, **kw). For example::
-===================
-Ipython integration
-===================
-
+=====================
+ Ipython integration
+=====================
After installing the module, if you use IPython, you can set up the `%mprun`
and `%memit` magics by following these steps.
@@ -165,7 +163,6 @@ For more details, see the docstrings of the magics.
============================
Frequently Asked Questions
============================
-
* Q: How accurate are the results ?
* A: This module gets the memory consumption by querying the
operating system kernel about the ammount of memory the current
View
3  setup.py
@@ -2,7 +2,7 @@
from distutils.core import setup
CLASSIFIERS = """\
-Development Status :: 4 - Beta
+Development Status :: 5 - Production/Stable
Intended Audience :: Science/Research
Intended Audience :: Developers
License :: OSI Approved
@@ -24,5 +24,6 @@
url='http://pypi.python.org/pypi/memory_profiler',
py_modules=['memory_profiler'],
classifiers=[_f for _f in CLASSIFIERS.split('\n') if _f],
+ license='Simplified BSD'
)
Please sign in to comment.
Something went wrong with that request. Please try again.