Skip to main content

Bringing Wardley Map magic to Jupyter notebooks.

Project description

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

  • Support more of the OWM syntax and features (?=maybe?):
    • evolution Novel->Emerging->Good->Best and evolution X offering the different sets of x-axis labels.
    • y-axis Value Chain->Invisible->Visible or y-axis none to make 'Visibility' axis optional.
    • evolve
    • annotation & annotations?
    • note?
    • market nodes?
    • pipeline nodes?
    • node inertia?
    • +<> links to indicate flow.
    • +> links to indicate flow.
    • +< links to indicate flow.
    • Hot Water+'$0.10'>Kettle flow labels?
    • build, buy, outsource node augmentation?
    • submap and related syntax?
    • pioneer, settler, townplanner areas/boxes?
  • Add 'Uncharted' and 'Industrialised' labels
  • Support rendering from a file, via e.g. %wardley file=example.owm style=plain
  • Make it easier to download the SVG/rendered version?

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.

Making a Release

As per https://flit.pypa.io/en/stable/

  1. Update version in \_\_init\_\_.py
  2. Commit, tag, push.
  3. flit publish

Change Log

Project details


Download files

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

Source Distribution

ipywardley-0.0.7.tar.gz (449.4 kB view hashes)

Uploaded Source

Built Distribution

ipywardley-0.0.7-py2.py3-none-any.whl (18.5 kB view hashes)

Uploaded Python 2 Python 3

Supported by

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