cgy1992 / python-plantuml Goto Github PK

###Python-PlantUML

Plantuml is a library for generating UML diagrams from a simple text markup language.

This is a simple python remote client interface to a plantuml server using the same custom encoding used by most other plantuml clients. Python was missing from the list, and while there are other plantuml python libraries, like sphinxcontrib-plantuml, they require downloading and installing the java executable and spawning a shell subprocesses.

This client defaults to the public plantuml server, but can be used against any server.

###Install

pip install git+https://github.com/SamuelMarks/python-plantuml#egg=plantuml

PS: At some point this newer version will be uploaded to PyPi, at which point you can do:

pip install plantuml

###Command line help:

usage: plantuml.py [-h] [-o OUT] [-s SERVER] filename [filename ...]

Generate images from plantuml defined files using plantuml server

positional arguments:
  filename              file(s) to generate images from

optional arguments:
  -h, --help            show this help message and exit
  -o OUT, --out OUT     directory to put the files into
  -s SERVER, --server SERVER
                        server to generate from, defaults to plantuml.com

###Project Links:

• Documentation
• PyPi
• GitHub