https://github.com/mgedmin/objgraph

Visually explore Python object graphs
https://github.com/mgedmin/objgraph

Last synced: 3 days ago
JSON representation

Visually explore Python object graphs

• Host: GitHub
• URL: https://github.com/mgedmin/objgraph
• Owner: mgedmin
• License: mit
• Created: 2013-08-09T08:48:21.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2024-10-10T12:04:52.000Z (3 months ago)
• Last Synced: 2024-12-25T22:03:11.947Z (17 days ago)
• Language: Python
• Homepage: http://mg.pov.lt/objgraph/
• Size: 5.44 MB
• Stars: 777
• Watchers: 16
• Forks: 73
• Open Issues: 22
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• my-awesome - mgedmin/objgraph - 10 star:0.8k fork:0.1k Visually explore Python object graphs (Python)

README

        
Python Object Graphs

====================

.. 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 `_ if you want to draw

the pretty graphs.

I recommend `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

`_.

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

  `_

* `Python object graphs

  `_

* `Object graphs with graphviz

  `_

.. _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.