Metadata-Version: 1.0
Name: objgraph
Version: 1.5.0
Summary: Draws Python object reference graphs with graphviz
Home-page: http://mg.pov.lt/objgraph/
Author: Marius Gedminas
Author-email: marius@gedmin.as
License: MIT
Description: Python Object Graphs
        ====================
        
        ``objgraph`` is a module that lets you visually explore Python object graphs.
        
        You'll need `graphviz <http://www.graphviz.org/>`_ if you want to draw
        the pretty graphs.
        
        I recommend `xdot <http://pypi.python.org/pypi/xdot>`_ for interactive use.
        ``pip install xdot`` should suffice; objgraph will automatically look for it
        in your ``PATH``.
        
        
        Installation and Documentation
        ------------------------------
        
        ``pip install objgraph`` or `download it from PyPI
        <http://pypi.python.org/pypi/objgraph>`_.
        
        Documentation lives at http://mg.pov.lt/objgraph.
        
        
        .. _history:
        
        History
        -------
        
        I've developed a set of functions that eventually became objgraph when I
        was hunting for memory leaks in a Python program.  The whole story -- with
        illustrated examples -- is in this series of blog posts:
        
        * `Hunting memory leaks in Python
          <http://mg.pov.lt/blog/hunting-python-memleaks.html>`_
        * `Python object graphs
          <http://mg.pov.lt/blog/python-object-graphs.html>`_
        * `Object graphs with graphviz
          <http://mg.pov.lt/blog/object-graphs-with-graphviz.html>`_
        
        
        .. _devel:
        
        Support and Development
        -----------------------
        
        The source code can be found in this Bazaar repository:
        https://code.launchpad.net/~mgedmin/objgraph/trunk.
        
        To check it out, use ``bzr branch lp:objgraph``.
        
        Report bugs at https://bugs.launchpad.net/objgraph.
        
        
        
        
        Changes
        =======
        
        
        
        1.5.0 (2010-12-05)
        ------------------
        
        Show frame objects as well (fixes `LP#361704
        <http://launchpad.net/bugs/361704>`_).
        
        New functions: `show_growth`, `show_chain`.
        
        `find_backref_chain` returns ``[obj]`` instead of ``None`` when a chain
        could not be found.  This makes ``show_chain(find_backref_chain(...), ...)``
        not break.
        
        Show how many references were skipped from the output of
        `show_refs`/`show_backrefs` by specifying ``too_many``.
        
        Make `show_refs` descend into modules.
        
        Do not highlight classes that define a ``__del__``, highlight only instances of
        those classes.
        
        Option to show reference counts in `show_refs`/`show_backrefs`.
        
        Add `Sphinx <http://pypi.python.org/pypi/Sphinx>`_ documentation and a PyPI
        long description.
        
        
        1.4.0 (2010-11-03)
        ------------------
        
        Compatibility with Python 2.4 and 2.5 (``tempfile.NamedTemporaryFile`` has no
        ``delete`` argument).
        
        New function: `most_common_types`.
        
        
        1.3.1 (2010-07-17)
        ------------------
        
        Rebuild an sdist with no missing files (fixes `LP#606604
        <http://launchpad.net/bugs/606604>`_).
        
        Added MANIFEST.in and a Makefile to check that setup.py sdist generates
        source distributions with no files missing.
        
        
        1.3 (2010-07-13)
        ----------------
        
        Highlight objects with a ``__del__`` method.
        
        Fixes `LP#483411 <http://launchpad.net/bugs/483411>`_: suggest always passing
        ``[obj]`` to `show_refs`, `show_backrefs`, since obj might be a
        list/tuple.
        
        Fixes `LP#514422 <http://launchpad.net/bugs/514422>`_: `show_refs`,
        `show_backrefs` don't create files in the current working directory any
        more.  Instead they accept a filename argument, which can be a .dot file or a
        .png file.  If None or not specified, those functions will try to spawn xdot
        as before.
        
        New extra_info argument to graph-generating functions (patch by Thouis Jones,
        `LP#558914 <http://launchpad.net/bugs/558914>`_).
        
        setup.py should work with distutils now (`LP#604430
        <http://launchpad.net/bugs/604430>`_, thanks to Randy Heydon).
        
        
        1.2 (2009-03-25)
        ----------------
        
        Project website, public source repository, uploaded to PyPI.
        
        No code changes.
        
        
        1.1 (2008-09-10)
        ----------------
        
        New function: `show_refs` for showing forward references.
        
        New functions: `typestats` and `show_most_common_types`.
        
        Object boxes are less crammed with useless information (such as IDs).
        
        Spawns `xdot <http://pypi.python.org/pypi/xdot>`_ if it is available.
        
        
        1.0 (2008-06-14)
        ----------------
        
        First public release.
        
Platform: UNKNOWN
