{"id":15014848,"url":"https://github.com/jbn/iplantuml","last_synced_at":"2025-04-09T13:09:19.869Z","repository":{"id":41113897,"uuid":"56625005","full_name":"jbn/IPlantUML","owner":"jbn","description":"A Python package which defines a PlantUML cell magic for IPython.","archived":false,"fork":false,"pushed_at":"2023-03-13T10:58:42.000Z","size":19,"stargazers_count":98,"open_issues_count":14,"forks_count":29,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-04-09T13:09:13.973Z","etag":null,"topics":["ipython","jupyter-notebook","plantuml","uml","uml-diagram"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jbn.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2016-04-19T19:18:27.000Z","updated_at":"2024-12-09T07:58:10.000Z","dependencies_parsed_at":"2022-09-09T06:21:30.231Z","dependency_job_id":"c04508e9-9ed3-4b5d-970c-f60d882101bc","html_url":"https://github.com/jbn/IPlantUML","commit_stats":{"total_commits":26,"total_committers":8,"mean_commits":3.25,"dds":0.6153846153846154,"last_synced_commit":"007bc57b5280600d7c9e858a80241e36858df587"},"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbn%2FIPlantUML","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbn%2FIPlantUML/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbn%2FIPlantUML/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jbn%2FIPlantUML/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jbn","download_url":"https://codeload.github.com/jbn/IPlantUML/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248045245,"owners_count":21038554,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ipython","jupyter-notebook","plantuml","uml","uml-diagram"],"created_at":"2024-09-24T19:46:10.332Z","updated_at":"2025-04-09T13:09:19.848Z","avatar_url":"https://github.com/jbn.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":".. image:: https://travis-ci.org/jbn/IPlantUML.svg?branch=master\n    :target: https://travis-ci.org/jbn/IPlantUML\n\nWhat is it?\n===========\n\nThis Python package defines a `PlantUML \u003chttp://plantuml.com/\u003e`__ cell\nmagic for IPython. It lets you generate UML diagrams as inline SVG in\nyour notebook. I'll add embellishments as needed. But, for now, I just\nneeded something that worked and existed as a package (in pypi).\n\nI based my code on `Steven Burke \u003chttps://github.com/sberke\u003e`__'s\n`plantuml\ngist \u003chttp://chickenbit.com/blog/2014/10/inline-plantuml-diagrams-in-ipython-notebook/\u003e`__.\n\nInstallation\n------------\n\nFirst, install IPlantuml with pip.\n\n.. code:: sh\n\n    pip install iplantuml\n\nThen, install plantuml. On Debian based system you can install plantuml\npackage. Otherwise you can download ``plantuml.jar`` and copy it to\n``/usr/local/bin/plantuml.jar``.\n\n.. code:: sh\n\n    sudo apt install plantuml\n\nAlternatively you can set a custom path for plantuml.jar during\ninstallation\n\n.. code:: sh\n\n    git clone https://github.com/jbn/IPlantUML.git\n    cd IPlantUML\n    python setup.py install iplantuml --jarpath /my/custom/path/plantuml.jar\n\nUsage\n-----\n\nIn Ipython, first,\n\n.. code:: python\n\n    import iplantuml\n\nthen, create a cell like,\n\n::\n\n    %%plantuml --jar\n\n    @startuml\n    Alice -\u003e Bob: Authentication Request\n    Bob --\u003e Alice: Authentication Response\n    @enduml\n\nThe output will be the generated SVG UML diagram using the plantuml.jar on your local system. To utilise remote rendering on plantweb omit the `--jar` argument:\n\n::\n\n    %%plantuml\n\n    @startuml\n    Alice -\u003e Bob: Authentication Request\n    Bob --\u003e Alice: Authentication Response\n    @enduml\n\n\nBy default, the magic removes the intermediate (``tmp.uml``) and target\n(``tmp.svg``) files. However, if you enter a name in the ``%%plantuml``\nline, it retains both files of ``$name.uml`` and ``$name.svg``. For\nexample,\n\n::\n\n    %%plantuml auth\n\n    @startuml\n    Alice -\u003e Bob: Authentication Request\n    Bob --\u003e Alice: Authentication Response\n    @enduml\n\ngenerates and retains ``auth.uml`` and ``auth.svg``.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbn%2Fiplantuml","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjbn%2Fiplantuml","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjbn%2Fiplantuml/lists"}