{"author":null,"author_email":"Ero Carrera , Peter Nowee , Łukasz , \"FeRD (Frank Dana)\" ","bugtrack_url":null,"classifiers":["Development Status :: 5 - Production/Stable","Intended Audience :: Developers","Intended Audience :: Science/Research","Natural Language :: English","Operating System :: OS Independent","Programming Language :: Python :: 3","Programming Language :: Python :: 3.10","Programming Language :: Python :: 3.11","Programming Language :: Python :: 3.12","Programming Language :: Python :: 3.8","Programming Language :: Python :: 3.9","Topic :: Scientific/Engineering :: Visualization","Topic :: Software Development :: Libraries :: Python Modules"],"description":"\n\n![CI](https://github.com/pydot/pydot/actions/workflows/CI.yml/badge.svg)\n[![Coverage](https://raw.githubusercontent.com/pydot/pydot/python-coverage-comment-action-data/badge.svg)](https://htmlpreview.github.io/?https://github.com/pydot/pydot/blob/python-coverage-comment-action-data/htmlcov/index.html)\n[![PyPI](https://img.shields.io/pypi/v/pydot.svg)](https://pypi.org/project/pydot/)\n[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-purple.svg)](https://github.com/astral-sh/ruff)\n\n# Pydot\n\n`pydot` is a Python interface to Graphviz and its DOT language. You can use `pydot` to create, read, edit, and visualize graphs.\n\n- It's made in pure Python, with only one dependency – pyparsing – other than Graphviz itself.\n- It's compatible with `networkx`, which can convert its graphs to `pydot`.\n\nTo see what Graphviz is capable of, check the [Graphviz Gallery](https://graphviz.org/gallery/)!\n\n## Dependencies\n\n- [`pyparsing`][pyparsing]: used only for *loading* DOT files, installed automatically during `pydot` installation.\n- GraphViz: used to render graphs in a variety of formats, including PNG, SVG, PDF, and more.\n Should be installed separately, using your system's [package manager][pkg], something similar (e.g., [MacPorts][mac]), or from [its source][src].\n\n## Installation\n\n- Latest release, from [PyPI][pypi]:\n\n ```bash\n pip install pydot\n ```\n\n- Current development code, from this repository:\n\n ```bash\n pip install git+https://github.com/pydot/pydot.git\n ```\n\n- Development installation, to modify the code or contribute changes:\n\n ```bash\n # Clone the repository\n git clone https://github.com/pydot/pydot\n cd pydot\n\n # (Optional: create a virtual environment)\n python3 -m venv _venv\n . ./_venv/bin/activate\n\n # Make an editable install of pydot from the source tree\n pip install -e .\n ```\n\n## Quickstart\n\n### 1. Input\n\nNo matter what you want to do with `pydot`, you'll need some input to start with. Here are the common ways to get some data to work with.\n\n#### Import a graph from an existing DOT file\n\nLet's say you already have a file `example.dot` (based on an [example from Wikipedia][wiki_example]):\n\n```dot\ngraph my_graph {\n bgcolor=\"yellow\";\n a [label=\"Foo\"];\n b [shape=circle];\n a -- b -- c [color=blue];\n}\n```\n\nYou can read the graph from the file in this way:\n\n```python\nimport pydot\n\ngraphs = pydot.graph_from_dot_file(\"example.dot\")\ngraph = graphs[0]\n```\n\n#### Parse a graph from an existing DOT string\n\nUse this method if you already have a string describing a DOT graph:\n\n```python\nimport pydot\n\ndot_string = \"\"\"graph my_graph {\n bgcolor=\"yellow\";\n a [label=\"Foo\"];\n b [shape=circle];\n a -- b -- c [color=blue];\n}\"\"\"\n\ngraphs = pydot.graph_from_dot_data(dot_string)\ngraph = graphs[0]\n```\n\n#### Create a graph from scratch using pydot objects\n\nThis is where the cool stuff starts. Use this method if you want to build new graphs with Python code.\n\n```python\nimport pydot\n\ngraph = pydot.Dot(\"my_graph\", graph_type=\"graph\", bgcolor=\"yellow\")\n\n# Add nodes\nmy_node = pydot.Node(\"a\", label=\"Foo\")\ngraph.add_node(my_node)\n# Or, without using an intermediate variable:\ngraph.add_node(pydot.Node(\"b\", shape=\"circle\"))\n\n# Add edges\nmy_edge = pydot.Edge(\"a\", \"b\", color=\"blue\")\ngraph.add_edge(my_edge)\n# Or, without using an intermediate variable:\ngraph.add_edge(pydot.Edge(\"b\", \"c\", color=\"blue\"))\n```\n\nYou can use these basic building blocks in your Python program\nto dynamically generate a graph. For example, start with a\nbasic `pydot.Dot` graph object, then loop through your data\nas you add nodes and edges. Use values from your data as labels to\ndetermine shapes, edges and so on. This allows you to easily create\nvisualizations of thousands of related objects.\n\n#### Convert a NetworkX graph to a pydot graph\n\nNetworkX has conversion methods for pydot graphs:\n\n```python\nimport networkx\nimport pydot\n\n# See NetworkX documentation on how to build a NetworkX graph.\ngraph = networkx.drawing.nx_pydot.to_pydot(my_networkx_graph)\n```\n\n### 2. Edit\n\nYou can now further manipulate your graph using pydot methods:\n\nAdd more nodes and edges:\n\n```python\ngraph.add_edge(pydot.Edge(\"b\", \"d\", style=\"dotted\"))\n```\n\nEdit attributes of graphs, nodes and edges:\n\n```python\ngraph.set_bgcolor(\"lightyellow\")\ngraph.get_node(\"b\")[0].set_shape(\"box\")\n```\n\n### 3. Output\n\nHere are three different output options:\n\n#### Generate an image\n\nIf you just want to save the image to a file, use one of the `write_*` methods:\n```python\ngraph.write_png(\"output.png\")\n```\n\nIf you need to further process the image output, the `create_*` methods will get you a Python `bytes` object:\n```python\noutput_graphviz_svg = graph.create_svg()\n```\n\n#### Retrieve the DOT string\n\nThere are two different DOT strings you can retrieve:\n\n- The \"raw\" pydot DOT: This is generated the fastest and will\n usually still look quite similar to the DOT you put in. It is\n generated by pydot itself, without calling Graphviz.\n\n ```python\n # As a string:\n output_raw_dot = graph.to_string()\n # Or, save it as a DOT-file:\n graph.write_raw(\"output_raw.dot\")\n ```\n\n- The Graphviz DOT: You can use it to check how Graphviz lays out\n the graph before it produces an image. It is generated by\n Graphviz.\n\n ```python\n # As a bytes literal:\n output_graphviz_dot = graph.create_dot()\n # Or, save it as a DOT-file:\n graph.write_dot(\"output_graphviz.dot\")\n ```\n\n#### Convert to a NetworkX graph\n\nNetworkX has a conversion method for pydot graphs:\n\n```python\nmy_networkx_graph = networkx.drawing.nx_pydot.from_pydot(graph)\n```\n\n### More help\n\nFor more help, see the docstrings of the various pydot objects and\nmethods. For example, `help(pydot)`, `help(pydot.Graph)` and\n`help(pydot.Dot.write)`.\n\nMore [documentation contributions welcome][contrib].\n\n## Troubleshooting\n\n### Enable logging\n\n`pydot` uses Python's standard `logging` module. To see the logs,\nassuming logging has not been configured already:\n\n >>> import logging\n >>> logging.basicConfig(level=logging.DEBUG)\n >>> import pydot\n DEBUG:pydot:pydot initializing\n DEBUG:pydot:pydot \n DEBUG:pydot.core:pydot core module initializing\n DEBUG:pydot.dot_parser:pydot dot_parser module initializing\n\n**Warning**: When `DEBUG` level logging is enabled, `pydot` may log the\ndata that it processes, such as graph contents or DOT strings. This can\ncause the log to become very large or contain sensitive information.\n\n### Advanced logging configuration\n\n- Check out the [Python logging documentation][log] and the\n [`logging_tree`][log_tree] visualizer.\n- `pydot` does not add any handlers to its loggers, nor does it setup\n or modify your root logger. The `pydot` loggers are created with the\n default level `NOTSET`.\n- `pydot` registers the following loggers:\n - `pydot`: Parent logger. Emits a few messages during startup.\n - `pydot.core`: Messages related to pydot objects, Graphviz execution\n and anything else not covered by the other loggers.\n - `pydot.dot_parser`: Messages related to the parsing of DOT strings.\n\n\n## License\n\nDistributed under the [MIT license][MIT].\n\nThe module [`pydot._vendor.tempfile`][tempfile]\nis based on the Python 3.12 standard library module\n[`tempfile.py`][tempfile-src],\nCopyright © 2001-2023 Python Software Foundation. All rights reserved.\nLicensed under the terms of the [Python-2.0][Python-2.0] license.\n\n\n## Contacts\n\nCurrent maintainer(s): \n- Łukasz Łapiński \n\nPast maintainers:\n- Sebastian Kalinowski (GitHub: @prmtl)\n- Peter Nowee (GitHub: @peternowee)\n\nOriginal author: Ero Carrera \n\n\n[wiki_dot]: https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29\n[networkx]: https://github.com/networkx/networkx\n[pydot_gh]: https://github.com/pydot/pydot\n[wiki_example]: https://en.wikipedia.org/w/index.php?title=DOT_(graph_description_language)&oldid=1003001464#Attributes\n[contrib]: https://github.com/pydot/pydot/issues/130\n[pypi]: https://pypi.org/project/pydot/\n[pyparsing]: https://github.com/pyparsing/pyparsing\n[pkg]: https://en.wikipedia.org/wiki/Package_manager\n[mac]: https://www.macports.org\n[src]: https://gitlab.com/graphviz/graphviz\n[log]: https://docs.python.org/3/library/logging.html\n[log_tree]: https://pypi.org/project/logging_tree/\n[MIT]: https://github.com/pydot/pydot/blob/main/LICENSES/MIT.txt\n[Python-2.0]: https://github.com/pydot/pydot/blob/main/LICENSES/Python-2.0.txt\n[tempfile]: https://github.com/pydot/pydot/blob/main/src/pydot/_vendor/tempfile.py\n[tempfile-src]: https://github.com/python/cpython/blob/8edfa0b0b4ae4235bb3262d952c23e7581516d4f/Lib/tempfile.py\n","description_content_type":"text/markdown","docs_url":null,"download_url":null,"downloads":{"last_day":-1,"last_month":-1,"last_week":-1},"dynamic":["License-File"],"home_page":null,"keywords":"graphviz, dot, graphs, visualization","license":null,"license_expression":"MIT","license_files":["LICENSES/MIT.txt","LICENSES/Python-2.0.txt"],"maintainer":null,"maintainer_email":"Peter Nowee , Łukasz ","name":"pydot","package_url":"https://pypi.org/project/pydot/","platform":null,"project_url":"https://pypi.org/project/pydot/","project_urls":{"Bug Tracker":"https://github.com/pydot/pydot/issues","Changelog":"https://github.com/pydot/pydot/blob/main/ChangeLog","Homepage":"https://github.com/pydot/pydot"},"provides_extra":["lint","types","dev","tests","release"],"release_url":"https://pypi.org/project/pydot/4.0.0/","requires_dist":["pyparsing>=3.0.9","ruff; extra == \"lint\"","mypy; extra == \"types\"","pydot[lint]; extra == \"dev\"","pydot[types]; extra == \"dev\"","chardet; extra == \"dev\"","parameterized; extra == \"dev\"","pydot[dev]; extra == \"tests\"","tox; extra == \"tests\"","pytest; extra == \"tests\"","pytest-cov; extra == \"tests\"","pytest-xdist[psutil]; extra == \"tests\"","zest.releaser[recommended]; extra == \"release\""],"requires_python":">=3.8","summary":"Python interface to Graphviz's Dot","version":"4.0.0","yanked":false,"yanked_reason":null}

Dependency	Optional
pyparsing	false
chardet	true
mypy	true
parameterized	true
pydot	true
pytest	true
pytest-cov	true
pytest-xdist	true
ruff	true
tox	true
zest.releaser	true

Package search

pydot

project_urls

Dependencies

All package metadata

Releases