{"id":18769467,"url":"https://github.com/wireviz/wireviz-web","last_synced_at":"2025-08-22T05:31:15.837Z","repository":{"id":46166951,"uuid":"327457391","full_name":"wireviz/wireviz-web","owner":"wireviz","description":"WireViz-Web is a web wrapper around WireViz: Easily document cables and wiring harnesses","archived":false,"fork":false,"pushed_at":"2024-09-01T19:04:25.000Z","size":305,"stargazers_count":44,"open_issues_count":3,"forks_count":5,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-11-26T08:37:24.424Z","etag":null,"topics":["cable","cables","connector","connector-editor","connectors","harness","wiring","wiring-diagram","wiring-diagrams","wiring-harness"],"latest_commit_sha":null,"homepage":"https://community.hiveeyes.org/t/bringing-wireviz-to-the-web/3700","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wireviz.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-06T23:59:21.000Z","updated_at":"2024-11-05T15:23:34.000Z","dependencies_parsed_at":"2024-07-26T01:16:49.365Z","dependency_job_id":null,"html_url":"https://github.com/wireviz/wireviz-web","commit_stats":null,"previous_names":["daq-tools/wireviz-web"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wireviz%2Fwireviz-web","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wireviz%2Fwireviz-web/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wireviz%2Fwireviz-web/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wireviz%2Fwireviz-web/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wireviz","download_url":"https://codeload.github.com/wireviz/wireviz-web/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230561013,"owners_count":18245324,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cable","cables","connector","connector-editor","connectors","harness","wiring","wiring-diagram","wiring-diagrams","wiring-harness"],"created_at":"2024-11-07T19:15:58.489Z","updated_at":"2024-12-20T09:06:36.757Z","avatar_url":"https://github.com/wireviz.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"###########\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ürgen 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 \u003chttps://github.com/daq-tools/wireviz-web\u003e`_\n- `Documentation \u003chttps://github.com/daq-tools/wireviz-web/blob/main/README.rst\u003e`_\n- `Python Package Index (PyPI) \u003chttps://pypi.org/project/wireviz-web/\u003e`_\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ürgen 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","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwireviz%2Fwireviz-web","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwireviz%2Fwireviz-web","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwireviz%2Fwireviz-web/lists"}