A library for generating PlantUML diagrams
Project description
PythonPlantuml
PythonPlantUML Generator is a Python library for generating UML diagrams using PlantUML. It provides a simple interface to create SVG and PNG diagrams from PlantUML code.
Installation
You can install the PlantUML Generator using pip:
pip install pythonplantuml==0.2.0
Usage
Here's a basic example of how to use the PlantUML Generator:
from pythonplantuml import generate_uml_png
uml_code = """
@startuml
Alice -> Bob: Hello
Bob --> Alice: Hi!
@enduml
"""
generate_uml_png(uml_code, "output.png")
This will generate a PNG file named "output.png" with the UML diagram.
Features
- Generate SVG diagrams from PlantUML code
- Convert SVG diagrams to PNG
- Support for both local PlantUML jar and PlantUML web service
Documentation
For more detailed information about the PlantUML Generator, please refer to the full documentation. Development To set up the development environment:
Clone the repository Install the development dependencies:
pip install -r requirements.txt
Run the tests:
python -m unittest discover tests
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
License
This project is licensed under the MIT License - see the LICENSE file for details.
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
File details
Details for the file pythonplantuml-0.2.1.tar.gz
.
File metadata
- Download URL: pythonplantuml-0.2.1.tar.gz
- Upload date:
- Size: 5.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4b2eabfcc0a0364760d6647a6e935b7405689d747770236e91cf9eed7ad226cc |
|
MD5 | 344a4ee2ef2a597cc2609fcf0ff03796 |
|
BLAKE2b-256 | a7580929078f63b18451713293d84c758eef3d22053a711ea3ad5d41eca06e24 |
File details
Details for the file pythonplantuml-0.2.1-py3-none-any.whl
.
File metadata
- Download URL: pythonplantuml-0.2.1-py3-none-any.whl
- Upload date:
- Size: 6.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.11.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47c85ec2e48048ea1aeed03df68db96159e53fc7df84e80f592eb6a82db5df04 |
|
MD5 | 0e596bd946898ec7a2d7a5c6f4215868 |
|
BLAKE2b-256 | 4b03285566b38773189819dbe0b3d05bd42bf73fb3947bad150a99e5964283ad |