https://github.com/EntilZha/pygraph

CLI interface to python graphviz
https://github.com/EntilZha/pygraph

Last synced: about 2 months ago
JSON representation

CLI interface to python graphviz

• Host: GitHub
• URL: https://github.com/EntilZha/pygraph
• Owner: EntilZha
• License: mit
• Created: 2016-02-11T02:34:28.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2016-09-07T19:24:43.000Z (about 8 years ago)
• Last Synced: 2024-07-03T20:14:23.863Z (3 months ago)
• Language: Python
• Size: 57.6 KB
• Stars: 44
• Watchers: 3
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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`