Home

Awesome

ipywardley

Bringing Wardley Map magic to Jupyter notebooks

PyPI version

Introduction

This plugin makes it easy to generate Wardley Maps using Jupyter Notebooks.

It supports a subset of the syntax defined by the Online Wardley Maps service. This simple language can be use to specify the map via the %%wardley cell magic.

Try it out!

Run on Binder or Open In Colab

Installation

First, install Jupyter. Then before running it, install ipywardley. e.g. if you are using pip:

pip install ipywardley

Then, run Jupyter:

jupyter-lab

Usage

Open up a new Python 3 notebook, and use this command to enable the module:

%load_ext ipywardley

Now you can use the %%wardley directive and create maps. See this example notebook for a detailed example of how to do this.

Screenshot

example-map

To Do

Development

  1. Clone this directory.
  2. Set up a virtualenv and activate it.
  3. Modify the code.
  4. Run flit install
  5. Run jupyter-lab and test your changes.
  6. Repeat 3-5 ad infinitum.
  7. Turn your changes into a pull request.

Change Log