PlantUML¶
The PlantUML client module.
- class confirm.tools.plantuml.PlantUMLClient(server)¶
A class which reads the UML source from stdin, or a file, and then generates the appropriate image to stdout, or another file.
- create_image(image_format)¶
Create an image from the UML.
- Parameters:
image_format (str) – The image format
- Returns:
Generated image
- Return type:
bytes
- print_image(image_format)¶
Create an image from the UML, and print it on stdout.
- Parameters:
image_format (str) – The image format
- read_file(uml_file)¶
Read UML from a file.
- Parameters:
uml_file (pathlib.Path) – The UML file
- read_stdin()¶
Read UML from stdin.
- save_image(image_format, image_path=None)¶
Create an image from the UML, and save it on the filesystem.
- Parameters:
image_format (str) – The image format
image_path (None or pathlib.Path) – The image path
- confirm.tools.plantuml.main()¶
Run main CLI script.