.. image:: https://github.com/mgedmin/objgraph/workflows/build/badge.svg?branch=master :target: https://github.com/mgedmin/objgraph/actions :alt: Build Status
.. image:: https://ci.appveyor.com/api/projects/status/github/mgedmin/objgraph?branch=master&svg=true :target: https://ci.appveyor.com/project/mgedmin/objgraph :alt: Build Status (Windows)
.. image:: https://coveralls.io/repos/mgedmin/objgraph/badge.svg?branch=master :target: https://coveralls.io/r/mgedmin/objgraph?branch=master :alt: Test Coverage
.. image:: https://readthedocs.org/projects/objgraph/badge/?version=latest :target: https://readthedocs.org/projects/objgraph/?badge=latest :alt: Documentation Status
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.
pip install objgraph or download it from PyPI <https://pypi.python.org/pypi/objgraph>_.
Documentation lives at https://mg.pov.lt/objgraph.
.. _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:
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.