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

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

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

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

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

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

Options:
-e, --engine [dot|neato|twopi|circo|fdp|sfdp|patchword|osage]
Choose layout engine to use
-u, --undirected / -d, --directed
Specify undirected or directed edges
--format TEXT Image format
-n, --name TEXT Name of graph in image
--dot Preserve the source dot file
--no-vertex-labels Don't label vertex labels
--help Show this message and exit.
```

### Installation
```bash
pip install pygraph-cli
```

### Syntax
* First argument is file to save to without extension
* Pairs of single characters after are interpreted as creating an edge between the them (eg: `ab ac cd`)
* 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
* To keep the original dot source, pass `--dot`

Project details


Download files

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

Files for pygraph-cli, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size pygraph_cli-0.1.0-py2.py3-none-any.whl (3.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size pygraph-cli-0.1.0.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page