Convert C++ header files to PlantUML
Project description
Motivation
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.
Usage
The hpp2plantuml package can be used from the command line or as a module in other applications.
Command line
The command line usage is (hpp2plantuml --help):
usage: hpp2plantuml [-h] -i HEADER-FILE [-o FILE] [-t JINJA-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 -t JINJA-FILE, --template-file JINJA-FILE path to jinja2 template 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 customize the output PlantUML file, templates can be used (using the -t parameter):
hpp2plantuml -i File_1.hpp -i "include/Helper_*.hpp" -o output.puml -t template.puml
This will use the template.puml file as template. Templates follow the `jinja <http://jinja.pocoo.org/>`_ syntax. For instance, to add a preamble to the PlantUML output, the template file may contain:
- ::
- name:
usage-template
{% extends ‘default.puml’ %}
{% block preamble %} title “This is a title” skinparam backgroundColor #EEEBDC skinparam handwritten true {% endblock %}
This will inherit from the default template and override the preamble only.
Module
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. See the API documentation for more details.
Installation
Using pip
The package is available on PyPi and can be installed using pip:
pip install hpp2plantuml
From source
The code uses setuptools, so it can be built using:
python setup.py install
To build the documentation, run:
python setup.py sphinx
To run the tests, run:
python setup.py test
The full documentation is available via:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for hpp2plantuml-0.5.linux-x86_64.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 41a580806c75e605b4a96fa689cd709a14967d898b7e4ed64f44432d1c4f1ff3 |
|
MD5 | 6a09e89daddb9cbb7f337c6941bc0073 |
|
BLAKE2b-256 | 9e3eb2f1ec94e8bfba6ecdad5ed663697e137e73b8cdff6ff1645cad3ef90760 |
Hashes for hpp2plantuml-0.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ced41ead3ed061389329732aad056610c7083a7ff3c8065b5f6fee5bd6314ced |
|
MD5 | a388f8cdc7c79fabc79f6f1139f213ec |
|
BLAKE2b-256 | 073b973b8ef983fb6ba45da255f548dad6bb23b159557ab3571eef03c488092d |