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
[![Build Status](https://travis-ci.org/jbn/IPlantUML.svg?branch=master)](https://travis-ci.org/jbn/IPlantUML)

# What is it?

This Python package defines a [PlantUML](http://plantuml.com/) cell magic for
IPython. It lets you generate UML diagrams as inline SVG in your notebook. I'll
add embellishments as needed. But, for now, I just needed something that worked
and existed as a package (in pypi).

I based my code on [Steven Burke](https://github.com/sberke)'s
[plantuml gist](http://chickenbit.com/blog/2014/10/inline-plantuml-diagrams-in-ipython-notebook/)

## Installation

First, install IPlantum with pip.

```sh
pip install iplantuml
```

Then, download `plantuml.jar` and copy it to `/usr/local/bin/plantuml.jar`.

Alternatively you can set a custom path for plantuml.jar during installation

```sh
pip install iplantuml --jarpath /my/custom/path/plantuml.jar
```


## Usage

In Ipython, first,

```python
import iplantuml
```

then, create a cell like,

```
%%plantuml

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
@enduml
```

The output will be the generated SVG UML diagram.

By default, the magic removes the intermediate (`tmp.uml`) and target
(`tmp.svg`) files. However, if you enter a name in the `%%plantuml` line,
it retains both files of `$name.uml` and `$name.svg`. For example,

```
%%plantuml auth

@startuml
Alice -> Bob: Authentication Request
Bob --> Alice: Authentication Response
@enduml
```

generates and retains `auth.uml` and `auth.svg`.
Release History

Release History

0.0.4

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.0.3

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.0.2

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.0.1

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
IPlantUML-0.0.4.tar.gz (2.6 kB) Copy SHA256 Checksum SHA256 Source Jan 24, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS 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