Convert C++ header files to PlantUML
The purpose of this tool is to convert C++ header files to a UML representation in PlantUML syntax that can be used to generate diagrams with PlantUML.
PlantUML is a program rendering UML diagrams from plain text inputs using an expressive language.
This package generates the text input to PlantUML from C++ header files. Its ambition is limited but it should produce reasonable conversion for simple class hierarchies. It aims at supporting:
- class members with properties (private, method, protected), methods with basic qualifiers (static, abstract),
- inheritance relationships,
- aggregation relationships (very basic support).
The package relies on the CppHeaderParser package for parsing of C++ header files.
The hpp2plantuml package can be used from the command line or as a module in other applications.
The command line usage is (hpp2plantuml --help):
usage: hpp2plantuml [-h] -i HEADER-FILE [-o FILE] [--version] hpp2plantuml tool. optional arguments: -h, --help show this help message and exit -i HEADER-FILE, --input-file HEADER-FILE input file (must be quoted when using wildcards) -o FILE, --output-file FILE output file --version show program's version number and exit
Input files are added using the -i option. Inputs can be full file paths or include wildcards. Note that double quotes are required when using wildcards. The output file is selected with the -o option. The output is a text file following the PlantUML syntax.
For instance, the following command will generate an input file for PlantUML (output.puml) from several header files.
hpp2plantuml -i File_1.hpp -i "include/Helper_*.hpp" -o output.puml
To use as a module, simply import hpp2plantuml. The CreatePlantUMLFile function can then be used to create a PlantUML file from a set of input files. Alternatively, the Diagram object can be used directly to build internal objects (from files or strings). The Diagram.render() method can be used to produce a string output instead of writing to a text file.
The package is available on PyPi and can be installed using pip:
pip install hpp2plantuml
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size||File type||Python version||Upload date||Hashes|
|Filename, size hpp2plantuml-0.3-py2.py3-none-any.whl (13.5 kB)||File type Wheel||Python version py2.py3||Upload date||Hashes View|
|Filename, size hpp2plantuml-0.3.tar.gz (73.7 kB)||File type Source||Python version None||Upload date||Hashes View|
Hashes for hpp2plantuml-0.3-py2.py3-none-any.whl