Orthogram
=========
Orthogram is a command line program and Python library that lets you
draw block diagrams. It reads the definition of a diagram from a YAML
file and produces a PNG file like this one:
.. image:: examples/showoff.png
:width: 100%
:alt: Complex diagram demonstrating the capabilities of the program
Target audience
---------------
This project might be of interest to you if:
* You do not want to use a GUI. You prefer your diagrams defined in
plain text files.
* You know where your blocks should be, but you would rather have the
computer maintain the connections for you.
* You tried to force `Graphviz`_ or `PlantUML`_ to output the layout
you want, but to no avail.
.. _Graphviz: https://graphviz.org/
.. _PlantUML: https://plantuml.com/
Installation and usage
----------------------
Install from PyPI:
.. code::
pip install orthogram
Assuming there is a diagram definition file named ``diagram.yaml`` in
your current directory, run the following command to produce a PNG
file:
.. code::
python -m orthogram diagram.yaml
Please read the full online `documentation`_ for more.
.. _documentation: https://orthogram.readthedocs.org
Raw data
{
"_id": null,
"home_page": "https://github.com/yorgath/orthogram",
"name": "orthogram",
"maintainer": "Georgios Athanasiou",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "yorgath@gmail.com",
"keywords": "block,diagram,graph",
"author": "Georgios Athanasiou",
"author_email": "yorgath@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/21/6b/c90ce083eb343f7d48eebf0e856abf43dd29798c67060a525ec3d14df64c/orthogram-0.8.2.tar.gz",
"platform": null,
"description": "Orthogram\n=========\n\nOrthogram is a command line program and Python library that lets you\ndraw block diagrams. It reads the definition of a diagram from a YAML\nfile and produces a PNG file like this one:\n\n.. image:: examples/showoff.png\n :width: 100%\n :alt: Complex diagram demonstrating the capabilities of the program\n\nTarget audience\n---------------\n\nThis project might be of interest to you if:\n\n* You do not want to use a GUI. You prefer your diagrams defined in\n plain text files.\n* You know where your blocks should be, but you would rather have the\n computer maintain the connections for you.\n* You tried to force `Graphviz`_ or `PlantUML`_ to output the layout\n you want, but to no avail.\n\n.. _Graphviz: https://graphviz.org/\n.. _PlantUML: https://plantuml.com/\n\nInstallation and usage\n----------------------\n\nInstall from PyPI:\n\n.. code::\n\n pip install orthogram\n\nAssuming there is a diagram definition file named ``diagram.yaml`` in\nyour current directory, run the following command to produce a PNG\nfile:\n\n.. code::\n\n python -m orthogram diagram.yaml\n\nPlease read the full online `documentation`_ for more.\n\n.. _documentation: https://orthogram.readthedocs.org\n",
"bugtrack_url": null,
"license": "GPL-3.0-or-later",
"summary": "Draw block diagrams.",
"version": "0.8.2",
"project_urls": {
"Documentation": "https://readthedocs.org/projects/orthogram/",
"Homepage": "https://github.com/yorgath/orthogram",
"Repository": "https://github.com/yorgath/orthogram"
},
"split_keywords": [
"block",
"diagram",
"graph"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "370bd1b42bbde50a18d5c4318d521e7568d9dae94d1c718b462cfc2a45a6a6af",
"md5": "f3454cb232d869c7e5afbac2e8b2819b",
"sha256": "fe47942b3372ceac8c1464cabdbfe3aff4b1dc0be30a54f9e05fb441b2a69a97"
},
"downloads": -1,
"filename": "orthogram-0.8.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f3454cb232d869c7e5afbac2e8b2819b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 82129,
"upload_time": "2023-11-19T13:15:31",
"upload_time_iso_8601": "2023-11-19T13:15:31.682365Z",
"url": "https://files.pythonhosted.org/packages/37/0b/d1b42bbde50a18d5c4318d521e7568d9dae94d1c718b462cfc2a45a6a6af/orthogram-0.8.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "216bc90ce083eb343f7d48eebf0e856abf43dd29798c67060a525ec3d14df64c",
"md5": "6bb925fdf06697172d08ecf9a97f13f2",
"sha256": "2150f25c5e38ec01e6546d63d7cc95da935639845036f407cd4f11dece20faf7"
},
"downloads": -1,
"filename": "orthogram-0.8.2.tar.gz",
"has_sig": false,
"md5_digest": "6bb925fdf06697172d08ecf9a97f13f2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 69921,
"upload_time": "2023-11-19T13:15:34",
"upload_time_iso_8601": "2023-11-19T13:15:34.088474Z",
"url": "https://files.pythonhosted.org/packages/21/6b/c90ce083eb343f7d48eebf0e856abf43dd29798c67060a525ec3d14df64c/orthogram-0.8.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-19 13:15:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "yorgath",
"github_project": "orthogram",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "orthogram"
}
JSON
