Skip to main content

A Python package to create and visualise Wardley Maps

Project description

WardleyMap

WardleyMap is a Python package designed for creating and visualizing Wardley Maps. Wardley Maps provide a visual representation of the strategic landscape and the positioning of components within it, facilitating better decision-making in business strategy and technology development.

Features

  • Parse and interpret Wardley Map syntax.
  • Visualize maps using matplotlib for easy integration into Python workflows.
  • Export maps to SVG format for embedding in web applications or documents.
  • With a set of utilities to convert Wardley Map text into JSON, TOML, GRAPH and Cypher Text.

Installation

Install wardleymap using pip:

pip install wardleymap

Ensure you have Python 3.6 or newer installed.

Quick Start

To create and visualize a Wardley Map, follow these steps:

from wardleymap import wardlemap

# Define the structure of your Wardley Map using a string.
map_definition = """
title Business Value Chain
anchor Customer [0.95, 0.9]
component User Needs [0.8, 0.8]
component Website [0.6, 0.6]
component Hosting [0.3, 0.4]
User Needs -> Website
Website -> Hosting
"""

# Process the Wardley Map text and generate a plot of the map
map, map_plot = wardley(map=map_text)

# Convert the map plot into an SVG
svg_map = create_svg_map(map_plot)

Documentation

For detailed usage and API documentation, please refer to the docs directory.

Contributing

Contributions to WardleyMap are welcome! Please read the CONTRIBUTING.md file for guidelines on how to contribute to this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgements

  • Special thanks to the open-source community for the invaluable tools and libraries.
  • Inspired by Simon Wardley's work on mapping and strategy.

Example Usage

Below is an example of how to use the wardleymap package to create and visualize a Wardley Map:

from wardleymap import wardlemap

# Define the structure of your Wardley Map using a string.
map_definition = """
title Business Value Chain
anchor Customer [0.95, 0.9]
component User Needs [0.8, 0.8]
component Website [0.6, 0.6]
component Hosting [0.3, 0.4]
User Needs -> Website
Website -> Hosting
"""

# Process the Wardley Map text and generate a plot of the map
map, map_plot = wardley(map=map_text)

# Convert the map plot into an SVG
svg_map = create_svg_map(map_plot)

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

wardleymap-0.1.20.tar.gz (18.5 kB view details)

Uploaded Source

Built Distribution

wardleymap-0.1.20-py3-none-any.whl (20.1 kB view details)

Uploaded Python 3

File details

Details for the file wardleymap-0.1.20.tar.gz.

File metadata

  • Download URL: wardleymap-0.1.20.tar.gz
  • Upload date:
  • Size: 18.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for wardleymap-0.1.20.tar.gz
Algorithm Hash digest
SHA256 b3e6b12ccdb7af197b77512b75bd8d4ed84191eabe780861758e49a3601cea81
MD5 6c907752aca9aae922cb62895908f3e5
BLAKE2b-256 8922026147c6ea991f0a53d9971c54ba29ea6f4b432cf66cd12c61c98d81e68c

See more details on using hashes here.

File details

Details for the file wardleymap-0.1.20-py3-none-any.whl.

File metadata

  • Download URL: wardleymap-0.1.20-py3-none-any.whl
  • Upload date:
  • Size: 20.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for wardleymap-0.1.20-py3-none-any.whl
Algorithm Hash digest
SHA256 16ea586edb08af9a6523ed086b5a9ab4c482407012cbebc346dde2645bbc250c
MD5 2b1ef9fe8966d05c6822191279bbadd1
BLAKE2b-256 2c316fb80d8b6cf6fc0a3ac18a29da7b4081dd545afa34036db94512fa4bb1a0

See more details on using hashes here.

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