Skip to main content
Python Software Foundation 20th Year Anniversary Fundraiser  Donate today!

diagram-autobuild improves the efficiency of the making diagrams

Project description

# diagram-autobuild


## What is this?

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

- graphviz (
- blockdiag (
- nwdiag (
- actdiag (
- seqdiag (
- 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


$ pip install git+

## How to use

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

--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
$ diagram-autobuild graphviz

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

Example (ERAlchemy):
$ ls
$ diagram-autobuild eralchemy

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

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 diagram-autobuild, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size diagram_autobuild-0.1.0-py2.py3-none-any.whl (9.5 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size diagram-autobuild-0.1.0.tar.gz (4.9 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page