Skip to main content

A Jupyter Notebook %%magic for drawing diagram using kroki.io

Project description

Jupyter Kroki Magic

A Jupyter Notebook %%magic for drawing diagrams using kroki.io

Usage

Load extension inside a Jupyter notebook:

%load_ext krokimagic

Add code with Cell magic:

%%kroki [diagram-type]

# diagram syntax

Examples

%%kroki plantuml

skinparam monochrome true
skinparam ranksep 20
skinparam dpi 150
skinparam arrowThickness 0.7
skinparam packageTitleAlignment left
skinparam usecaseBorderThickness 0.4
skinparam defaultFontSize 12
skinparam rectangleBorderThickness 1

rectangle "Main" {
  (main.view)
  (singleton)
}
rectangle "Base" {
  (base.component)
  (component)
  (model)
}
rectangle "<b>main.ts</b>" as main_ts

(component) ..> (base.component)
main_ts ==> (main.view)
(main.view) --> (component)
(main.view) ...> (singleton)
(singleton) ---> (model)

Installation

$ pip install jupyter-kroki-magic

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

jupyter_kroki_magic-0.1.0-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

Details for the file jupyter_kroki_magic-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: jupyter_kroki_magic-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.55.0 CPython/3.7.4

File hashes

Hashes for jupyter_kroki_magic-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 223f746c9b05ae8e4ee0a89324a81bf48efe09d0c58342064223f6bfd1e6bc8a
MD5 2d30620eccdc9bad8c91d7453b8d2b06
BLAKE2b-256 40c8dfe8810e2dddcd7b3c20c7c10baa7638ca4543abccfcf225dfd7ea305ca1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page