Skip to main content

A wrapper around WireViz for bringing it to the web. Easily document cables and wiring harnesses.

Project description

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 an URL query parameter decoder by Dyno Fu and Rudi Yardley.

Thanks!

Details

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.

Synopsis

# Render a plain YAML file.
echo "Bob -> Alice : hello" > test.yml
http --form http://127.0.0.1:3005/render yml_file@test.yml Accept:image/svg+xml
http --form http://127.0.0.1:3005/render yml_file@test.yml Accept:image/png

# Render a PlantUML request.
http http://127.0.0.1:3005/svg/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==
http http://127.0.0.1:3005/png/SyfFKj2rKt3CoKnELR1Io4ZDoSa700==

Development

As this is still in its infancy, we humbly ask for support from the community. Look around, give it a test drive and submit patches.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wireviz-web-0.0.0.tar.gz (16.4 kB view hashes)

Uploaded Source

Built Distribution

wireviz_web-0.0.0-py3-none-any.whl (28.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page