Skip to main content

Simple Python interface for Graphviz

Project description

Latest PyPI Version License Supported Python Versions Wheel format Monthly downloads

Build Codecov Readthedocs (stable) Readthedocs (latest)

Binder (stable)

This package facilitates the creation and rendering of graph descriptions in the DOT language of the Graphviz graph drawing software (upstream repo) from Python.

Create a graph object, assemble the graph by adding nodes and edges, and retrieve its DOT source code string. Save the source code to a file and render it with the Graphviz installation of your system.

Use the view option/method to directly inspect the resulting (PDF, PNG, SVG, etc.) file with its default application. Graphs can also be rendered and displayed within Jupyter notebooks (formerly known as IPython notebooks, example, nbviewer) as well as the Jupyter QtConsole.

Installation

This package runs under Python 3.7+, use pip to install:

$ pip install graphviz

To render the generated DOT source code, you also need to install Graphviz (download page, archived versions, installation procedure for Windows).

Make sure that the directory containing the dot executable is on your systems’ PATH (sometimes done by the installer; setting PATH on Linux, Mac, and Windows).

Anaconda: see the conda-forge package conda-forge/python-graphviz (feedstock), which should automatically conda install conda-forge/graphviz (feedstock) as dependency.

Quickstart

Create a graph object:

>>> import graphviz  # doctest: +NO_EXE
>>> dot = graphviz.Digraph(comment='The Round Table')
>>> dot  #doctest: +ELLIPSIS
<graphviz.graphs.Digraph object at 0x...>

Add nodes and edges:

>>> dot.node('A', 'King Arthur')  # doctest: +NO_EXE
>>> dot.node('B', 'Sir Bedevere the Wise')
>>> dot.node('L', 'Sir Lancelot the Brave')

>>> dot.edges(['AB', 'AL'])
>>> dot.edge('B', 'L', constraint='false')

Check the generated source code:

>>> print(dot.source)  # doctest: +NORMALIZE_WHITESPACE +NO_EXE
// The Round Table
digraph {
    A [label="King Arthur"]
    B [label="Sir Bedevere the Wise"]
    L [label="Sir Lancelot the Brave"]
    A -> B
    A -> L
    B -> L [constraint=false]
}

Save and render the source code:

>>> doctest_mark_exe()

>>> dot.render('doctest-output/round-table.gv').replace('\\', '/')
'doctest-output/round-table.gv.pdf'

Save and render and view the result:

>>> doctest_mark_exe()

>>> dot.render('doctest-output/round-table.gv', view=True)  # doctest: +SKIP
'doctest-output/round-table.gv.pdf'
round-table.svg

Caveat: Backslash-escapes and strings of the form <...> have a special meaning in the DOT language. If you need to render arbitrary strings (e.g. from user input), check the details in the user guide.

See also

License

This package is distributed under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

graphviz-0.20.1.zip (255.2 kB view hashes)

Uploaded source

Built Distribution

graphviz-0.20.1-py3-none-any.whl (47.0 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page