Create UML diagrams from Protobuf proto files

Project description

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 (not compiled) .proto files in a directory:

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

License

Apache License

Project details

Release history Release notifications | RSS feed

0.13

Nov 22, 2023

0.12

Mar 11, 2023

0.11

Aug 22, 2022

0.10

Apr 18, 2022

This version

0.9

Dec 8, 2021

0.8

Sep 25, 2021

0.7

Oct 5, 2020

0.6

Jul 24, 2020

0.5

May 27, 2020

0.4

Mar 3, 2020

0.3

Oct 17, 2019

0.2

Sep 30, 2019

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

Uploaded Dec 8, 2021 Source

Built Distribution

protobuf_uml_diagram-0.9-py3-none-any.whl (8.7 kB view details)

Uploaded Dec 8, 2021 Python 3

File details

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

File metadata

Download URL: protobuf-uml-diagram-0.9.tar.gz
Upload date: Dec 8, 2021
Size: 8.3 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.3

File hashes

Hashes for protobuf-uml-diagram-0.9.tar.gz
Algorithm	Hash digest
SHA256	`2ffa9dd55d784368b2f26f91e7895b8c6a93fa11c20a934e08ba80f590861dd6`
MD5	`b8877f8a31d79a2135e3ddf6921db196`
BLAKE2b-256	`a96e3a59a34d9d0803126e75e8cf3d4b0fa0cb64e588a6621a282ffcac9bd518`

See more details on using hashes here.

File details

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

File metadata

Download URL: protobuf_uml_diagram-0.9-py3-none-any.whl
Upload date: Dec 8, 2021
Size: 8.7 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.3

File hashes

Hashes for protobuf_uml_diagram-0.9-py3-none-any.whl
Algorithm	Hash digest
SHA256	`24d1e5783decde272cba2697c1df0db8988f8ef401570e6988faae3192cba98b`
MD5	`003ed1698a8e609afa21964c4d6577aa`
BLAKE2b-256	`91b070f8fb838ace53cb643c33629c650eb97dd97fd7b817172bba6ac4c26e2d`