Skip to main content

Create UML diagrams from Protobuf proto files

Project description

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

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

Alternative to installation

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.2.tar.gz (7.4 kB view details)

Uploaded Source

Built Distribution

protobuf_uml_diagram-0.2-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: protobuf-uml-diagram-0.2.tar.gz
  • Upload date:
  • Size: 7.4 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.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for protobuf-uml-diagram-0.2.tar.gz
Algorithm Hash digest
SHA256 3a131ab182252e3b44df3422ee09d619dc45a599b4e934dd9b73eb8ae58a32eb
MD5 2b385aee4a609ca0c57298fce7795c26
BLAKE2b-256 746efe92298b8ae57b58e1a34ee807e6ced6cf8f82275268c6743dad9ce4eed0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: protobuf_uml_diagram-0.2-py3-none-any.whl
  • Upload date:
  • Size: 8.2 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.0.1 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.7.3

File hashes

Hashes for protobuf_uml_diagram-0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 94e380ce0e813bc54abb895e9dd2ff2577e6f2833c30eafbcecdc6a257a98eda
MD5 c4f99765a5b691bcfb049f2bf5a7db04
BLAKE2b-256 627f5e084dbdffcd2026a24cedc250e7ffb583f6a96e3f350802e64b6a35386f

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