`blockdiag` generate block-diagram image file from spec-text file.
.. image:: https://github.com/blockdiag/blockdiag/actions/workflows/main.yml/badge.svg
:target: https://github.com/blockdiag/blockdiag/actions/workflows/main.yml
:alt: GitHub Action CI build status
.. image:: https://img.shields.io/pypi/v/blockdiag
:target: https://pypi.python.org/pypi/blockdiag/
:alt: Latest PyPI version
.. image:: https://img.shields.io/pypi/dm/blockdiag
:target: https://pypi.python.org/pypi/blockdiag/
:alt: Number of PyPI downloads
Features
========
* Generate block-diagram from dot like text (basic feature).
* Multilingualization for node-label (utf-8 only).
You can get some examples and generated images on
`blockdiag.com <http://blockdiag.com/en/blockdiag/examples.html>`_ .
Setup
=====
Use pip::
$ sudo pip install blockdiag
If you want to export as PDF format, give pdf arguments::
$ sudo pip install "blockdiag[pdf]"
Copy and modify ini file. example::
$ cp <blockdiag installed path>/blockdiag/examples/simple.diag .
$ vi simple.diag
Please refer to `spec-text setting sample`_ section for the format of the
`simpla.diag` configuration file.
spec-text setting sample
========================
Few examples are available.
You can get more examples at
`blockdiag.com`_ .
simple.diag
------------
simple.diag is simply define nodes and transitions by dot-like text format::
diagram admin {
top_page -> config -> config_edit -> config_confirm -> top_page;
}
screen.diag
------------
screen.diag is more complexly sample. diaglam nodes have a alternative label
and some transitions::
diagram admin {
top_page [label = "Top page"];
foo_index [label = "List of FOOs"];
foo_detail [label = "Detail FOO"];
foo_add [label = "Add FOO"];
foo_add_confirm [label = "Add FOO (confirm)"];
foo_edit [label = "Edit FOO"];
foo_edit_confirm [label = "Edit FOO (confirm)"];
foo_delete_confirm [label = "Delete FOO (confirm)"];
bar_detail [label = "Detail of BAR"];
bar_edit [label = "Edit BAR"];
bar_edit_confirm [label = "Edit BAR (confirm)"];
logout;
top_page -> foo_index;
top_page -> bar_detail;
foo_index -> foo_detail;
foo_detail -> foo_edit;
foo_detail -> foo_delete_confirm;
foo_index -> foo_add -> foo_add_confirm -> foo_index;
foo_index -> foo_edit -> foo_edit_confirm -> foo_index;
foo_index -> foo_delete_confirm -> foo_index;
bar_detail -> bar_edit -> bar_edit_confirm -> bar_detail;
}
Usage
=====
Execute blockdiag command::
$ blockdiag simple.diag
$ ls simple.png
simple.png
Requirements
============
* Python 3.7 or later
* Pillow 3.0 or later
* funcparserlib 1.0.0a0 or later
* reportlab (optional)
* wand and imagemagick (optional)
* setuptools
License
=======
Apache License 2.0
Raw data
{
"_id": null,
"home_page": "http://blockdiag.com/",
"name": "blockdiag",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "diagram,generator",
"author": "Takeshi Komiya",
"author_email": "i.tkomiya@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b4/eb/e2a4b6d5bf7f7121104ac7a1fc80b5dfa86ba286adbd1f25bf32a090a5eb/blockdiag-3.0.0.tar.gz",
"platform": "",
"description": "`blockdiag` generate block-diagram image file from spec-text file.\n\n.. image:: https://github.com/blockdiag/blockdiag/actions/workflows/main.yml/badge.svg\n :target: https://github.com/blockdiag/blockdiag/actions/workflows/main.yml\n :alt: GitHub Action CI build status\n\n.. image:: https://img.shields.io/pypi/v/blockdiag\n :target: https://pypi.python.org/pypi/blockdiag/\n :alt: Latest PyPI version\n\n.. image:: https://img.shields.io/pypi/dm/blockdiag\n :target: https://pypi.python.org/pypi/blockdiag/\n :alt: Number of PyPI downloads\n\n\nFeatures\n========\n* Generate block-diagram from dot like text (basic feature).\n* Multilingualization for node-label (utf-8 only).\n\nYou can get some examples and generated images on\n`blockdiag.com <http://blockdiag.com/en/blockdiag/examples.html>`_ .\n\nSetup\n=====\n\nUse pip::\n\n $ sudo pip install blockdiag\n\nIf you want to export as PDF format, give pdf arguments::\n\n $ sudo pip install \"blockdiag[pdf]\"\n\n\nCopy and modify ini file. example::\n\n $ cp <blockdiag installed path>/blockdiag/examples/simple.diag .\n $ vi simple.diag\n\nPlease refer to `spec-text setting sample`_ section for the format of the\n`simpla.diag` configuration file.\n\nspec-text setting sample\n========================\nFew examples are available.\nYou can get more examples at\n`blockdiag.com`_ .\n\nsimple.diag\n------------\nsimple.diag is simply define nodes and transitions by dot-like text format::\n\n diagram admin {\n top_page -> config -> config_edit -> config_confirm -> top_page;\n }\n\nscreen.diag\n------------\nscreen.diag is more complexly sample. diaglam nodes have a alternative label\nand some transitions::\n\n diagram admin {\n top_page [label = \"Top page\"];\n\n foo_index [label = \"List of FOOs\"];\n foo_detail [label = \"Detail FOO\"];\n foo_add [label = \"Add FOO\"];\n foo_add_confirm [label = \"Add FOO (confirm)\"];\n foo_edit [label = \"Edit FOO\"];\n foo_edit_confirm [label = \"Edit FOO (confirm)\"];\n foo_delete_confirm [label = \"Delete FOO (confirm)\"];\n\n bar_detail [label = \"Detail of BAR\"];\n bar_edit [label = \"Edit BAR\"];\n bar_edit_confirm [label = \"Edit BAR (confirm)\"];\n\n logout;\n\n top_page -> foo_index;\n top_page -> bar_detail;\n\n foo_index -> foo_detail;\n foo_detail -> foo_edit;\n foo_detail -> foo_delete_confirm;\n foo_index -> foo_add -> foo_add_confirm -> foo_index;\n foo_index -> foo_edit -> foo_edit_confirm -> foo_index;\n foo_index -> foo_delete_confirm -> foo_index;\n\n bar_detail -> bar_edit -> bar_edit_confirm -> bar_detail;\n }\n\n\nUsage\n=====\nExecute blockdiag command::\n\n $ blockdiag simple.diag\n $ ls simple.png\n simple.png\n\n\nRequirements\n============\n* Python 3.7 or later\n* Pillow 3.0 or later\n* funcparserlib 1.0.0a0 or later\n* reportlab (optional)\n* wand and imagemagick (optional)\n* setuptools\n\n\nLicense\n=======\nApache License 2.0\n\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "blockdiag generates block-diagram image from text",
"version": "3.0.0",
"split_keywords": [
"diagram",
"generator"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cfcdb82f859a9ebc4d24c1a8b901a68df0d90aa717fd4d47d6166db9449dc0ff",
"md5": "4f98b10b3fb3e3b888fc6264a7eca393",
"sha256": "4031bfae6a7f36071d733dec639987346e10f7871356ee2c7a221961c64961d8"
},
"downloads": -1,
"filename": "blockdiag-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f98b10b3fb3e3b888fc6264a7eca393",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 2721044,
"upload_time": "2021-12-06T16:43:55",
"upload_time_iso_8601": "2021-12-06T16:43:55.022844Z",
"url": "https://files.pythonhosted.org/packages/cf/cd/b82f859a9ebc4d24c1a8b901a68df0d90aa717fd4d47d6166db9449dc0ff/blockdiag-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b4ebe2a4b6d5bf7f7121104ac7a1fc80b5dfa86ba286adbd1f25bf32a090a5eb",
"md5": "e1bfc69b83254ad3565c572ff4b3ad97",
"sha256": "dee4195bb87d23654546ba2bf5091480dbf253b409891fce2cd527c91d00a3e2"
},
"downloads": -1,
"filename": "blockdiag-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e1bfc69b83254ad3565c572ff4b3ad97",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 2694464,
"upload_time": "2021-12-06T16:43:56",
"upload_time_iso_8601": "2021-12-06T16:43:56.394142Z",
"url": "https://files.pythonhosted.org/packages/b4/eb/e2a4b6d5bf7f7121104ac7a1fc80b5dfa86ba286adbd1f25bf32a090a5eb/blockdiag-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2021-12-06 16:43:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "blockdiag"
}
JSON