This is a pre-production deployment of Warehouse, however changes made here WILL affect the production instance of PyPI.
Latest Version Dependencies status unknown Test status unknown Test coverage unknown
Project Description

# pyplantuml

![](docs/pyplantuml_packages.png)

Creates UML diagrams (package and class structure) from Python source code.

Build on top of pylint’s pyreverse to do the static code analysis and supports most of its original commandline interface.

It basically outputs plantuml description as text files instead of .dot files. The plantuml code features a simple syntax and is a great base for manual extension, e.g. to sketch out ideas on how to evolve the data model.

## Installation

From pypi:

$ pip install pyplantuml

From source:

$ python setup.py develop

After installation it is available from the commandline as two commands, see below.

## Dependencies

## Usage

$ cd <parent-dir-of-package>

$ pyplantuml [pyreverse-options] <package>

If a plantuml.jar can be found on PATH, it will automatically be called afterwards to convert the text files to images.

$ pyplantuml-web [pyreverse-options] <package>

Will use the online form on www.plantuml.com for conversion and display the result in your default browser. Do not use for sensitive data!

## Examples

pyplantuml is a great way to visualize the data structure of an existing package. It can be used on custom packages as well as builtins, as some of the examples below illustrate.

### ast ![](docs/ast_classes.png)

### logging ![](docs/logging_classes.png)

### maxjob ![](docs/maxjob_packages.png) ![](docs/maxjob_classes.png)

### pluggy ![](docs/pluggy_classes.png)

### re ![](docs/re_classes.png)

### setuptools ![](docs/setuptools_classes.png)

### SocketServer ![](docs/SocketServer_classes.png)

### tokenize ![](docs/tokenize_classes.png)

### tox ![](docs/tox_classes.png)

### urllib ![](docs/urllib_classes.png)

### webbrowser ![](docs/webbrowser_classes.png)

Release History

Release History

0.1.51

This version

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

0.1.5

History Node

TODO: Figure out how to actually get changelog content.

Changelog content for this version goes here.

Donec et mollis dolor. Praesent et diam eget libero egestas mattis sit amet vitae augue. Nam tincidunt congue enim, ut porta lorem lacinia consectetur. Donec ut libero sed arcu vehicula ultricies a non tortor. Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Show More

Download Files

Download Files

TODO: Brief introduction on what you do with files - including link to relevant help section.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
pyplantuml-0.1.51.zip (10.2 kB) Copy SHA256 Checksum SHA256 Source Apr 4, 2016

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS HPE HPE Development Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting