Metadata-Version: 2.1
Name: protobuf-uml-diagram
Version: 0.11
Summary: Create UML diagrams from Protobuf proto files
Home-page: https://github.com/kinow/protobuf-uml-diagram/
Author: Bruno P. Kinoshita
Author-email: brunodepaulak@yahoo.com.br
License: UNKNOWN
Description: [![PyPI](https://img.shields.io/pypi/v/protobuf-uml-diagram.svg?color=yellow)](https://pypi.org/project/protobuf-uml-diagram/)
        [![License](https://img.shields.io/github/license/kinow/protobuf-uml-diagram.svg?color=lightgrey)](https://github.com/kinow/protobuf-uml-diagram/blob/master/LICENSE.txt)
        [![CI](https://github.com/kinow/protobuf-uml-diagram/actions/workflows/main.yml/badge.svg?branch=master&event=push)](https://github.com/kinow/protobuf-uml-diagram/actions/workflows/main.yml)
        [![codecov](https://codecov.io/gh/kinow/protobuf-uml-diagram/branch/master/graph/badge.svg)](https://codecov.io/gh/kinow/protobuf-uml-diagram)
        
        [![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/X8X1618T2)
        
        # Protobuf UML diagram
        
        A tool to generate UML diagrams from Protobuf compiled .proto files.
        
        _Usage_:
        
        ```bash
        $ protobuf-uml-diagram --proto "cylc.flow.ws_messages_pb2" --output /tmp/
        ```
        
        _Logging output_:
        
        ```bash
        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](https://raw.githubusercontent.com/kinow/protobuf-uml-diagram/master/example-output.png "Example output")
        
        ## TL;DR
        
        ```bash
        $ pip install protobuf-uml-diagram
        (…)
        $ file issue_10.proto  # See ./test_data/ or use your own .proto file.
        issue_10.proto: ASCII text
        $ protoc --python_out=./ issue_10.proto
        $ # The line below modifies PYTHONPATH, which is not necessary if you have a valid Python module/package.
        $ PYTHONPATH=. protobuf-uml-diagram --proto issue_10_pb2 --output /tmp
        INFO:protobuf_uml_diagram:Imported: issue_10_pb2
        INFO:protobuf_uml_diagram:Writing diagram to /tmp/issue_10_pb2.png
        $ eog /tmp/issue_10_pb2.png
        ```
        
        Running the command above should create a final image with your diagram as seen below.
        
        ![](./.github/docs/issue_10_pb2.png)
        
        ## Installation
        
        ```bash
        $ pip install protobuf-uml-diagram
        $ protobuf-uml-diagram
        ```
        
        ### Development
        
        ```bash
        $ 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
        
Platform: UNKNOWN
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: tests
Provides-Extra: all
