Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

diagram-autobuild improves the efficiency of the making diagrams

Project Description
# diagram-autobuild

![diagram-autobuild-demo](https://raw.githubusercontent.com/wiki/momijiame/diagram-autobuild/images/diagram-autobuild.gif)

## What is this?

diagram-autobuild improves the efficiency of the making diagrams.
diagram-autobuild is supporting the following tools.

- graphviz (http://www.graphviz.org/)
- blockdiag (https://pypi.python.org/pypi/blockdiag)
- nwdiag (https://pypi.python.org/pypi/nwdiag)
- actdiag (https://pypi.python.org/pypi/actdiag)
- seqdiag (https://pypi.python.org/pypi/seqdiag)
- ERAlchemy (https://pypi.python.org/pypi/ERAlchemy)

### Background

If you make a diagram, you usually do the following cycle.

1. Edit the source (e.g. \*.dot)
2. Build the diagram (e.g. execute 'dot' command)
3. Open the diagram
4. Make sure whether the diagram is your intended (If it isn't so, retry from the first)

This procedure is inefficient and bother you.

### Solution

Automation: the above procedure between 2 and 3

diagram-autobuild observes the source file.
If the source file is modified, rebuild the diagram, and the browser which indicates the diagram is reloaded.

## How to install

diagram-autobuild is installed by using pip of Python's package manager.

```
$ pip install diagram-autobuild
```

or

```
$ pip install git+https://github.com/momijiame/diagram-autobuild.git
```

## How to use

You will be able to use 'diagram-autobuild' command.
```
$ diagram-autobuild --help
Usage: diagram-autobuild [OPTIONS] TOOL SOURCE

Options:
--tool-opts TEXT Options that are passed to the tool
--open-browser / --no-open-browser
Open your default browser when the command
is executed
--help Show this message and exit.
```

Execute 'diagram-autobuild' command with the tool name and the path of source file.
(The tool must to be installed already)

Example (graphviz):
```
$ ls
sample.dot
$ diagram-autobuild graphviz sample.dot
```

Example (blockdiag):
```
$ ls
sample.diag
$ diagram-autobuild blockdiag sample.diag
```

Example (ERAlchemy):
```
$ ls
sample.er
$ diagram-autobuild eralchemy sample.er
```

If it succeed, open your default browser and you can see the diagram.
Release History

Release History

This version
History Node

0.1.0

History Node

0.0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
diagram_autobuild-0.1.0-py2.py3-none-any.whl (9.5 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Dec 31, 2017
diagram-autobuild-0.1.0.tar.gz (4.9 kB) Copy SHA256 Checksum SHA256 Source Dec 31, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting