跳转到主要内容

WireViz的包装器,用于将其引入网络。轻松记录电缆和线束。

项目描述

https://github.com/daq-tools/wireviz-web/workflows/Tests/badge.svg https://codecov.io/gh/daq-tools/wireviz-web/branch/main/graph/badge.svg https://img.shields.io/pypi/v/wireviz-web.svg https://pepy.tech/badge/wireviz-web/month https://img.shields.io/pypi/pyversions/wireviz-web.svg https://img.shields.io/pypi/status/wireviz-web.svg https://img.shields.io/github/license/daq-tools/wireviz-web

关于

WireViz-Web是由WireViz(由Daniel Rojas开发)包装的,用于将其引入网络。

最初,它是由WireViz 分支的作者Jürgen Key构思的。为了与PlantUML兼容,它包括PlantUML 文本编码格式解码器,由Dyno FuRudi Yardley提供。

谢谢!

详细信息

WireViz

WireViz 是一个用于轻松记录电缆、线束和连接器引脚配置的工具。它接受纯文本、YAML 格式化文件作为输入,并利用Graphviz生成漂亮的图形输出(SVG、PNG 等)。它处理自动 BOM(物料清单)创建,并具有许多额外功能。

WireViz-Web

WireViz-Web 使用 Flask 通过 REST API 包装 WireViz,并为 PlantUML 提供特定的渲染端点。

设置

安装先决条件

{apt,brew,dnf,yum,zypper} install python3 graphviz

安装软件包

pip install wireviz-web

用法

运行服务器

wireviz-web

发起请求

# 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==

要访问 Swagger OpenAPI 规范,请访问 http://localhost:3005/doc

项目信息

贡献

所有类型的贡献、反馈或补丁都非常受欢迎。如果您认为我们应该包含新功能,或者要报告或修复错误,请创建问题或提交补丁。

要跟进一般开发讨论,请参阅将 WireViz 带到 Web 上

开发

为了在您的工作站上设置开发环境,请参阅开发沙盒文档。当您看到软件测试成功时,您应该准备好开始修改。

资源

许可证

本项目根据 GNU AGPL 许可协议授权。

项目详细信息


下载文件

为您的平台下载文件。如果您不确定要选择哪个,请了解有关安装软件包的更多信息。

源代码分发

wireviz_web-0.4.1.tar.gz (22.4 kB 查看哈希值

上传时间 源代码

构建分发

wireviz_web-0.4.1-py3-none-any.whl (33.8 kB 查看哈希值

上传时间 Python 3

由以下支持