Skip to main content

A Graphviz static wrapper for Python

Project description

graphviz-static

This is a Python package for Graphviz. It has static binaries inside for easy use.

You are working in cross-platform environment, and want to use graphviz without having to install it over and over again? Well, this package allows you to enjoy that moment by simply installs every platform possible in it (yes, this is a lazy approach)

Current version of Graphviz is 14.1.1

Inspired by static-ffmpeg.

Installation

pip install graphviz-static

Install this package with pip.

Usage

from graphviz_static import load_paths, export_to_image

# Start Graphviz (loads the right programs for your computer)
load_paths()

# Make a DOT file
dot_content = """
digraph G {
    node [shape=box, style=filled, color=lightblue];
    A -> B -> C;
    B -> D;
}
"""

# Save the file
with open("example.dot", "w", encoding="utf-8") as f:
    f.write(dot_content)

# Make a PNG picture
export_to_image("example.dot", "png", "output")

API Reference

load_paths()

This loads the right Graphviz programs for your computer and adds them to PATH.

export_to_image(dot_file, file_type="png", file_name="output")

This renders your dotfile into raster image.

  • dot_file: The path to your DOT file
  • file_type: The image format (png, svg, pdf, etc.)
  • file_name: The image name (without the type at the end)

This will returns your image result path.

get_dot_path()

This gives you the path to the dot program for your computer.

Supported Platforms

  • Windows (32-bit and 64-bit)
  • Linux (ARM64 and AARCH64) [experimental]

Notes

  • You can use this along with official graphviz, you just need to put the load_paths() in the code in order to work.

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_static-0.2.5.tar.gz (17.3 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

graphviz_static-0.2.5-py3-none-any.whl (17.4 MB view details)

Uploaded Python 3

File details

Details for the file graphviz_static-0.2.5.tar.gz.

File metadata

  • Download URL: graphviz_static-0.2.5.tar.gz
  • Upload date:
  • Size: 17.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.25

File hashes

Hashes for graphviz_static-0.2.5.tar.gz
Algorithm Hash digest
SHA256 65b6feca3db94020911af34bde5a28943a60b203180db54813f60a51143741f7
MD5 9846ac67bc32f7fd318013cd7741732f
BLAKE2b-256 9eccbed9668960eb1868315c51c3906df4f0d00be009c1fde5c08f4764fee029

See more details on using hashes here.

File details

Details for the file graphviz_static-0.2.5-py3-none-any.whl.

File metadata

File hashes

Hashes for graphviz_static-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 7a85d9130ca0e2ce6aeb88e7b3692368e11a07d30239fde5e940b5e60b4b24c1
MD5 402f20713110304e5ea8725de3602070
BLAKE2b-256 306a7acbfbd6759aabb0f15d5fd72b21244f73476f1b6d11c9b1a4acdab267bc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page