Skip to main content

CLI for pygraphviz powered by graphviz

Project description

# pygraph
pygraph is an extremely simple CLI tool for using graphviz. It takes a file to write to and
adjacency list to construct the graph from. The intended use case is for generating
small graphs to embed in things like homework problems. The API is documented via the `--help`
option

## Usage
```bash
$ pygraph --help
Usage: pygraph [OPTIONS] FILE EDGES...

Options:
-e, --engine [dot|neato|twopi|circo|fdp|sfdp|patchword|osage]
-u, --undirected / -d, --directed
--format TEXT
--help Show this message and exit.
```

## Syntax
* Pairs of single characters are interpreted as creating an edge between the first and second
* Nodes can have any name when separated by `-` (eg: `root-child`)
* To label the edge, append `:` and any text (eg: `root-child:label`)
* Name the image by passing `-n` option

### Examples
```bash
pygraph -d tree ab ac bd be
```

![tree](examples/tree.png)

```
pygraph -u -e neato circle ab bc cd de ea
```

![circle](examples/circle.png)

```
pygraph -d -n "Sample Tree" labeled-tree root-left:1 root-right:1 left-child:4 right-child:3 root-root:0
```

![labeled-tree](examples/labeled-tree.png)

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

pygraph-cli-0.0.0.tar.gz (3.4 kB view hashes)

Uploaded Source

Built Distribution

pygraph_cli-0.0.0-py2.py3-none-any.whl (3.6 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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