Skip to main content

A library for generating PlantUML diagrams

Project description

PyPlantuml

PyPlantUML 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 plantuml-generator

Usage

Here's a basic example of how to use the PlantUML Generator:

from plantuml_generator 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pythonplantuml-0.2.0.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

pythonplantuml-0.2.0-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file pythonplantuml-0.2.0.tar.gz.

File metadata

  • Download URL: pythonplantuml-0.2.0.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.4

File hashes

Hashes for pythonplantuml-0.2.0.tar.gz
Algorithm Hash digest
SHA256 cdd3256017938b78ba3f91a608e9e43369c9c249dde155f1188919ce1303308f
MD5 dfcc71273a2415d181456fec04cb0204
BLAKE2b-256 af610a2d6f3ab62d373041268e07fce9727d4a87caa10b8bfb50cf09d7d9556f

See more details on using hashes here.

File details

Details for the file pythonplantuml-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pythonplantuml-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0be0ce2a44990ac7a8098d4440d06882a4f3ada580df0a41e94db3df4b15f730
MD5 02480f8a6d6c3d70b761d65b7a366da2
BLAKE2b-256 44ce07640d500c10673db0c0cbfcbf91c3272fcb3c424bb1506a78dcf268bbf3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page