1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
|
Python Object Graphs
====================
``objgraph`` is a module that lets you visually explore Python object graphs.
You'll need `graphviz <https://www.graphviz.org/>`_ if you want to draw
the pretty graphs.
I recommend `xdot <https://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
<https://pypi.python.org/pypi/objgraph>`_.
Documentation lives at https://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
<https://mg.pov.lt/blog/hunting-python-memleaks.html>`_
* `Python object graphs
<https://mg.pov.lt/blog/python-object-graphs.html>`_
* `Object graphs with graphviz
<https://mg.pov.lt/blog/object-graphs-with-graphviz.html>`_
.. _devel:
Support and Development
-----------------------
The source code can be found in this Git repository:
https://github.com/mgedmin/objgraph.
To check it out, use ``git clone https://github.com/mgedmin/objgraph``.
Report bugs at https://github.com/mgedmin/objgraph/issues.
|