Hi there,
after @weef shared WireViz - a tool for easily documenting cables and wiring harnesses with us, we could not resist to think about what it would take to bring this fine tool to the Web.
Thankfully, some people in the community had already made a start on it, so our job was just to pick up those gems and put them into a package.
Here, we want to share some of the research and its outcome with you. Enjoy.
With kind regards,
Andreas.
WireViz integration research
Standing on the shoulders of giants.
WireViz GUI and Service
Within those discussions, Daniel Rojas , Jason , Jürgen Key and Tyler Ward are talking about the baseline work needed to bring the functionality of WireViz into a graphical user interface and a service.
Integration of TeX and WireViz into GitLab through PlantUML
Jürgen Key says:
GitLab already provides integration for PlantUML diagrams. I added two more: Wiring looms and harnesses can be easily and beautifully visualized with WireViz - I integrated this too. And - naturally - TeX formulas are a must…
This is how it works:
At the moment the application relies on two other servers - one for PlantUML and one for WireViz.
Andreas
January 10, 2021, 10:05pm
3
Hi again,
We finally have been able to publish the original code by Jürgen Key and contributors as an overhauled version within the package wireviz-web 0.1.0
…
… and announced that back to upstream .
opened 09:59PM - 10 Jan 21 UTC
Dear Daniel, Dear WireViz community,
first of all, we would like to salute yo… u for conceiving this excellent program. It has been brought to our attention just recently - thanks, @msweef.
Within the patches and discussions around #55 and #68, @formatc1702, @slightlynybbled, @elbosso and @Tyler-Ward have been talking about the baseline work needed to bring the functionality of WireViz into a graphical user interface and a (HTTP) service.
While @slightlynybbled went down the classic GUI route on behalf of `wireviz-gui` [1], @elbosso looked into the HTTP API aspects and implemented a Flask wrapper around WireViz on behalf of `server.py` [2]. On top of that, he also conceived `plantumlinterfaceproxy` [3] in order to integrate TeX and WireViz into GitLab through PlantUML. We summarized those efforts within [4]. Cheers!
Now, we started to build upon the work by @elbosso in order to put that into a standalone package `wireviz-web` [5] and hope that you will appreciate our efforts on that. While we published an initial version 0.0.0 on PyPI containing mostly the unmodified code some days ago, we have been able to put in some more hours in order to refactor and modernize it and just published version 0.1.0.
In order to extend the credits to people who contributed to this package, @dyno and @ryardley must not be missed as they provided a Python implementation for encoding and decoding the [PlantUML Text Encoding format](https://plantuml.com/text-encoding), which @elbosso already has been able to build upon within his initial implementation.
So, all of this is really a community effort and our humble role was just about putting some bits and pieces together and packaging it. Attaching to WireViz being released under an GPLv3 license, we just went ahead and put an AGPLv3 license on WireViz-Web. At the same time, we are humbly asking for any objections from the upstream authors on this matter.
Please let us know about anything what comes to your mind about this.
Keep up the spirit and with kind regards,
Andreas.
[1] https://github.com/slightlynybbled/wireviz-gui
[2] https://github.com/elbosso/WireViz/blob/master/src/app/server.py
[3] https://github.com/elbosso/plantumlinterfaceproxy
[4] https://community.hiveeyes.org/t/bringing-wireviz-to-the-web/3700
[5] https://github.com/daq-tools/wireviz-web
With kind regards,
Andreas.
1 Like