Metadata-Version: 1.1
Name: IPlantUML
Version: 0.0.5
Summary: Package which adds a PlantUML cell magic to IPython.
Home-page: https://github.com/jbn/iplantuml
Author: John Bjorn Nelson
Author-email: jbn@abreka.com
License: MIT
Description: .. image:: https://travis-ci.org/jbn/IPlantUML.svg?branch=master
            :target: 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.
        
        .. code:: 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
        
        .. code:: sh
        
            pip install iplantuml --jarpath /my/custom/path/plantuml.jar
        
        Usage
        -----
        
        In Ipython, first,
        
        .. code:: 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``.
        
        .. |Build Status| image:: https://travis-ci.org/jbn/IPlantUML.svg?branch=master
           :target: https://travis-ci.org/jbn/IPlantUML
        
Keywords: jupyter,ipython,uml,plantuml
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: IPython
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
