Skip to main content

Create UML diagrams from Protobuf proto files

Project description

PyPI License Build Status codecov

Protobuf UML diagram

A tool to generate UML diagrams from Protobuf compiled .proto files.

Usage:

$ protobuf-uml-diagram --proto "cylc.flow.ws_messages_pb2" --output /tmp/

Logging output:

INFO:__main__:Importing compiled proto cylc.flow.ws_messages_pb2
INFO:__main__:Writing PNG diagram to /tmp/ws_messages_pb2.png

Image output:

example output

Installation

$ pip install protobuf-uml-diagram
$ protobuf-uml-diagram

Development

$ git clone https://github.com/kinow/protobuf-uml-diagram.git
$ cd protobuf-uml-diagram
$ pip install -e .
$ protobuf-uml-diagram

Docker

Generate UML diagrams from all (uncompiled) .proto files in a directory:

./dockerbuild.sh
./dockerrun.sh <path_containing_proto_files> <output_path>

License

Apache License

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

protobuf-uml-diagram-0.3.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

protobuf_uml_diagram-0.3-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file protobuf-uml-diagram-0.3.tar.gz.

File metadata

  • Download URL: protobuf-uml-diagram-0.3.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for protobuf-uml-diagram-0.3.tar.gz
Algorithm Hash digest
SHA256 2a3faf89880f845cbb0192731f0f46364ecbdc70562f25485bc824a6035e574d
MD5 a23a1181210b54b86d4042b1c936b1d3
BLAKE2b-256 8d03984a8e409b7fc19c316d08847fb2d5cd608699b5ad2222204d4558016e7a

See more details on using hashes here.

File details

Details for the file protobuf_uml_diagram-0.3-py3-none-any.whl.

File metadata

  • Download URL: protobuf_uml_diagram-0.3-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for protobuf_uml_diagram-0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4f9154cbcf2afd1c3bed7424c8a9aed81afdb5ca3423a138bb10fc4161520614
MD5 f787831f3e08697d032c547c8ae31b22
BLAKE2b-256 37ae988ffda98e732fccdd48acbe714fbf0ebbcfa47896659c2e243023774baf

See more details on using hashes here.

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