###########
WireViz-Web
###########
.. image:: https://github.com/daq-tools/wireviz-web/workflows/Tests/badge.svg
:target: https://github.com/daq-tools/wireviz-web/actions?workflow=Tests
.. image:: https://codecov.io/gh/daq-tools/wireviz-web/branch/main/graph/badge.svg
:target: https://codecov.io/gh/daq-tools/wireviz-web
.. image:: https://img.shields.io/pypi/v/wireviz-web.svg
:target: https://pypi.org/project/wireviz-web/
.. image:: https://pepy.tech/badge/wireviz-web/month
:target: https://pepy.tech/project/wireviz-web
.. image:: https://img.shields.io/pypi/pyversions/wireviz-web.svg
:target: https://pypi.org/project/wireviz-web/
.. image:: https://img.shields.io/pypi/status/wireviz-web.svg
:target: https://pypi.org/project/wireviz-web/
.. image:: https://img.shields.io/github/license/daq-tools/wireviz-web
:target: https://github.com/daq-tools/wireviz-web/blob/main/LICENSE
*****
About
*****
WireViz-Web is a wrapper around the excellent WireViz_ by `Daniel Rojas`_
for bringing it to the web.
Originally, it has been conceived within a `WireViz fork`_ by `Jürgen Key`_.
For compatibility with PlantUML_, it includes a `PlantUML Text Encoding format`_
decoder by `Dyno Fu`_ and `Rudi Yardley`_.
Thanks!
*******
Details
*******
WireViz
=======
WireViz is a tool for easily documenting cables, wiring harnesses and connector pinouts.
It takes plain text, YAML-formatted files as input and produces beautiful graphical output
(SVG, PNG, ...) thanks to Graphviz_.
It handles automatic BOM (Bill of Materials) creation and has a lot of extra features.
WireViz-Web
===========
WireViz-Web wraps WireViz with a REST API using Flask. It also provides specific rendering
endpoints for PlantUML.
*****
Setup
*****
Install prerequisites::
{apt,brew,dnf,yum,zypper} install python3 graphviz
Install package::
pip install wireviz-web
*****
Usage
*****
Run server::
wireviz-web
Invoke requests::
# Acquire WireViz YAML file.
wget https://raw.githubusercontent.com/daq-tools/wireviz-web/main/tests/demo01.yaml
# Render images.
http --form http://localhost:3005/render yml_file@demo01.yaml Accept:image/svg+xml
http --form http://localhost:3005/render yml_file@demo01.yaml Accept:image/png
# Render HTML page with SVG image and BOM table.
http --form http://localhost:3005/render yml_file@demo01.yaml Accept:text/html
# Render BOM in TSV format.
http --form http://localhost:3005/render yml_file@demo01.yaml Accept:text/plain
# Render BOM in JSON format.
http --form http://localhost:3005/render yml_file@demo01.yaml Accept:application/json
# Render a PlantUML request.
http http://localhost:3005/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==
http http://localhost:3005/plantuml/png/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==
.. note::
The ``http`` command used in the examples is the excellent HTTPie_ program.
For visiting the Swagger OpenAPI spec, go to http://localhost:3005/doc.
*******************
Project information
*******************
Contributions
=============
Every kind of contribution, feedback, or patch, is much welcome. `Create an
issue`_ or submit a patch if you think we should include a new feature, or to
report or fix a bug.
In order to follow the general development discussion, please see `Bringing
WireViz to the Web`_.
Development
===========
In order to setup a development environment on your workstation, please head
over to the `development sandbox`_ documentation. When you see the software
tests succeed, you should be ready to start hacking.
Resources
=========
- `Source code repository <https://github.com/daq-tools/wireviz-web>`_
- `Documentation <https://github.com/daq-tools/wireviz-web/blob/main/README.rst>`_
- `Python Package Index (PyPI) <https://pypi.org/project/wireviz-web/>`_
License
=======
The project is licensed under the terms of the GNU AGPL license.
.. _Bringing WireViz to the Web: https://community.hiveeyes.org/t/bringing-wireviz-to-the-web/3700
.. _create an issue: https://github.com/daq-tools/wireviz-web/issues
.. _Daniel Rojas: https://github.com/formatc1702
.. _development sandbox: https://github.com/daq-tools/wireviz-web/blob/main/doc/sandbox.rst
.. _Dyno Fu: https://github.com/dyno
.. _Graphviz: https://www.graphviz.org/
.. _HTTPie: https://httpie.io/
.. _Jürgen Key: https://github.com/elbosso
.. _PlantUML: https://plantuml.com/
.. _PlantUML Text Encoding format: https://plantuml.com/text-encoding
.. _Poetry: https://pypi.org/project/poetry/
.. _Rudi Yardley: https://github.com/ryardley
.. _WireViz: https://github.com/formatc1702/WireViz
.. _WireViz fork: https://github.com/elbosso/WireViz
Raw data
{
"_id": null,
"home_page": "https://community.hiveeyes.org/t/bringing-wireviz-to-the-web/3700",
"name": "wireviz-web",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "cable,connector,connector-editor,hardware,harness,wiring,wiring-diagram,wiring-harness",
"author": "J\u00fcrgen Key",
"author_email": "jkey@arcor.de",
"download_url": "https://files.pythonhosted.org/packages/42/90/39a2c39c16a36eb2fe1645f7fc20dae0d65ff5afefc72760fee061af31b6/wireviz_web-0.4.1.tar.gz",
"platform": null,
"description": "###########\nWireViz-Web\n###########\n\n.. image:: https://github.com/daq-tools/wireviz-web/workflows/Tests/badge.svg\n :target: https://github.com/daq-tools/wireviz-web/actions?workflow=Tests\n.. image:: https://codecov.io/gh/daq-tools/wireviz-web/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/daq-tools/wireviz-web\n\n.. image:: https://img.shields.io/pypi/v/wireviz-web.svg\n :target: https://pypi.org/project/wireviz-web/\n.. image:: https://pepy.tech/badge/wireviz-web/month\n :target: https://pepy.tech/project/wireviz-web\n\n.. image:: https://img.shields.io/pypi/pyversions/wireviz-web.svg\n :target: https://pypi.org/project/wireviz-web/\n.. image:: https://img.shields.io/pypi/status/wireviz-web.svg\n :target: https://pypi.org/project/wireviz-web/\n.. image:: https://img.shields.io/github/license/daq-tools/wireviz-web\n :target: https://github.com/daq-tools/wireviz-web/blob/main/LICENSE\n\n\n*****\nAbout\n*****\nWireViz-Web is a wrapper around the excellent WireViz_ by `Daniel Rojas`_\nfor bringing it to the web.\n\nOriginally, it has been conceived within a `WireViz fork`_ by `J\u00fcrgen Key`_.\nFor compatibility with PlantUML_, it includes a `PlantUML Text Encoding format`_\ndecoder by `Dyno Fu`_ and `Rudi Yardley`_.\n\nThanks!\n\n\n*******\nDetails\n*******\n\nWireViz\n=======\n\nWireViz is a tool for easily documenting cables, wiring harnesses and connector pinouts.\nIt takes plain text, YAML-formatted files as input and produces beautiful graphical output\n(SVG, PNG, ...) thanks to Graphviz_.\nIt handles automatic BOM (Bill of Materials) creation and has a lot of extra features.\n\nWireViz-Web\n===========\n\nWireViz-Web wraps WireViz with a REST API using Flask. It also provides specific rendering\nendpoints for PlantUML.\n\n\n*****\nSetup\n*****\n\nInstall prerequisites::\n\n {apt,brew,dnf,yum,zypper} install python3 graphviz\n\nInstall package::\n\n pip install wireviz-web\n\n\n*****\nUsage\n*****\n\nRun server::\n\n wireviz-web\n\nInvoke requests::\n\n # Acquire WireViz YAML file.\n wget https://raw.githubusercontent.com/daq-tools/wireviz-web/main/tests/demo01.yaml\n\n # Render images.\n http --form http://localhost:3005/render yml_file@demo01.yaml Accept:image/svg+xml\n http --form http://localhost:3005/render yml_file@demo01.yaml Accept:image/png\n\n # Render HTML page with SVG image and BOM table.\n http --form http://localhost:3005/render yml_file@demo01.yaml Accept:text/html\n\n # Render BOM in TSV format.\n http --form http://localhost:3005/render yml_file@demo01.yaml Accept:text/plain\n\n # Render BOM in JSON format.\n http --form http://localhost:3005/render yml_file@demo01.yaml Accept:application/json\n\n # Render a PlantUML request.\n http http://localhost:3005/plantuml/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==\n http http://localhost:3005/plantuml/png/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==\n\n.. note::\n\n The ``http`` command used in the examples is the excellent HTTPie_ program.\n\nFor visiting the Swagger OpenAPI spec, go to http://localhost:3005/doc.\n\n\n\n*******************\nProject information\n*******************\n\nContributions\n=============\n\nEvery kind of contribution, feedback, or patch, is much welcome. `Create an\nissue`_ or submit a patch if you think we should include a new feature, or to\nreport or fix a bug.\n\nIn order to follow the general development discussion, please see `Bringing\nWireViz to the Web`_.\n\nDevelopment\n===========\n\nIn order to setup a development environment on your workstation, please head\nover to the `development sandbox`_ documentation. When you see the software\ntests succeed, you should be ready to start hacking.\n\nResources\n=========\n\n- `Source code repository <https://github.com/daq-tools/wireviz-web>`_\n- `Documentation <https://github.com/daq-tools/wireviz-web/blob/main/README.rst>`_\n- `Python Package Index (PyPI) <https://pypi.org/project/wireviz-web/>`_\n\nLicense\n=======\n\nThe project is licensed under the terms of the GNU AGPL license.\n\n\n.. _Bringing WireViz to the Web: https://community.hiveeyes.org/t/bringing-wireviz-to-the-web/3700\n.. _create an issue: https://github.com/daq-tools/wireviz-web/issues\n.. _Daniel Rojas: https://github.com/formatc1702\n.. _development sandbox: https://github.com/daq-tools/wireviz-web/blob/main/doc/sandbox.rst\n.. _Dyno Fu: https://github.com/dyno\n.. _Graphviz: https://www.graphviz.org/\n.. _HTTPie: https://httpie.io/\n.. _J\u00fcrgen Key: https://github.com/elbosso\n.. _PlantUML: https://plantuml.com/\n.. _PlantUML Text Encoding format: https://plantuml.com/text-encoding\n.. _Poetry: https://pypi.org/project/poetry/\n.. _Rudi Yardley: https://github.com/ryardley\n.. _WireViz: https://github.com/formatc1702/WireViz\n.. _WireViz fork: https://github.com/elbosso/WireViz\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "A wrapper around WireViz for bringing it to the web. Easily document cables and wiring harnesses.",
"version": "0.4.1",
"split_keywords": [
"cable",
"connector",
"connector-editor",
"hardware",
"harness",
"wiring",
"wiring-diagram",
"wiring-harness"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1332db19018b0dd5515bbae652a7194dbad5bad98d1bc707a72a4a01f2b8dd8b",
"md5": "cebb9dbdab05aa5a15caf54bc71a4cbd",
"sha256": "1862126cdfce6ddb15e491af0bc408eaecb1ef0285fd285e77b9898aa554c31a"
},
"downloads": -1,
"filename": "wireviz_web-0.4.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cebb9dbdab05aa5a15caf54bc71a4cbd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 33830,
"upload_time": "2023-01-17T23:15:36",
"upload_time_iso_8601": "2023-01-17T23:15:36.681313Z",
"url": "https://files.pythonhosted.org/packages/13/32/db19018b0dd5515bbae652a7194dbad5bad98d1bc707a72a4a01f2b8dd8b/wireviz_web-0.4.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "429039a2c39c16a36eb2fe1645f7fc20dae0d65ff5afefc72760fee061af31b6",
"md5": "99f9dbea241dc4808fa15a905b125286",
"sha256": "56a27a52f94bb9887920dc146f6dd553b674b23e321fabf2e49606f239821f36"
},
"downloads": -1,
"filename": "wireviz_web-0.4.1.tar.gz",
"has_sig": false,
"md5_digest": "99f9dbea241dc4808fa15a905b125286",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 22368,
"upload_time": "2023-01-17T23:15:38",
"upload_time_iso_8601": "2023-01-17T23:15:38.967752Z",
"url": "https://files.pythonhosted.org/packages/42/90/39a2c39c16a36eb2fe1645f7fc20dae0d65ff5afefc72760fee061af31b6/wireviz_web-0.4.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-01-17 23:15:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "wireviz-web"
}
JSON