Skip to main content

Roadmapper. A Roadmap-as-Code (RaC) python library for generating a roadmap by using python code

Project description

Banner

license release Wheel download count code size commit count CodeFactor python version CI

Roadmaper - an open source Roadmap as Code (RaC) python library

Purpose

The purpose of roadmapper python library is used to draw roadmap by using python code. This is the first Roadmap as Code (RaC) library. RaC helps to create and edit roadmap in a more efficient way without having to use any graphical tools that are not always easy to use to create or update a roadmap.

With git repository like GitHub or Bitbucket, roadmaps created using RaC can be version controlled, track changes and can be easily shared with others.

:book: For usage documentation, how-to guide and code examples, refer to Roadmapper Wiki.

View the Change Logs to find out the latest updates and additions in the most recent version.

multilingual roadmappper

Python version requirements:

  • Python 3.10+

Library Dependencies

  • python-dateutil >= 2.8.2
  • Pillow >= 11.3.0
  • drawsvg >= 2.3.0
  • rich >= 13.7.1
  • ruff >= 0.2.1

Any feedback or suggestions are welcome. Please feel free to create an issue or pull request.


Installation

Install from PyPI

pip install roadmapper

Upgrade to the latest version

If you are running older version of roadmap-generator, you can upgrade to the latest version by running the following command:

pip install --upgrade roadmapper

Documentation

Please refer to Roadmapper Wiki for more information on how to use this RaC library.



Code Example

:point_right: Note: In order for the following code to work, you will need to download the matariki-tech-logo.png file to your local storage. The png file can be downloaded from the \images\logo\ folder.

from roadmapper.roadmap import Roadmap
from roadmapper.timelinemode import TimelineMode

roadmap = Roadmap(1200, 400, colour_theme="BLUEMOUNTAIN")
roadmap.set_title("My Demo Roadmap")
roadmap.set_subtitle("Matariki Technologies Ltd")
roadmap.set_timeline(TimelineMode.MONTHLY, start="2025-01-01", number_of_items=18)
roadmap.add_logo(
    "matariki-tech-logo.png",
    position="top-right",
    width=50,
    height=50,
)

group = roadmap.add_group("Core Product Work Stream")

task = group.add_task("Base Functionality", "2025-01-01", "2025-10-31")
task.add_milestone("v.1.0", "2025-02-15")
task.add_milestone("v.1.1", "2025-08-01")

parellel_task = task.add_parallel_task("Enhancements", "2025-11-15", "2026-03-31")
parellel_task.add_milestone("v.2.0", "2026-03-30")

task = group.add_task("Showcase #1", "2025-03-01", "2025-05-07")
task.add_parallel_task("Showcase #2", "2025-06-01", "2025-08-07")

roadmap.set_footer("Generated by Roadmapper")
roadmap.draw()
roadmap.save("demo01.png")

Output

Roadmapper

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

roadmapper-1.5.5.tar.gz (50.2 kB view details)

Uploaded Source

Built Distribution

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

roadmapper-1.5.5-py3-none-any.whl (73.5 kB view details)

Uploaded Python 3

File details

Details for the file roadmapper-1.5.5.tar.gz.

File metadata

  • Download URL: roadmapper-1.5.5.tar.gz
  • Upload date:
  • Size: 50.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for roadmapper-1.5.5.tar.gz
Algorithm Hash digest
SHA256 869a5c46ea4bf9f3223d8453cc9de91063b7254c5a118075737b9bca130bb7b8
MD5 10698cd01bf8d82f8162e5091975d4ce
BLAKE2b-256 950c71c2f8809faec06d8f0d2d16d5659eaac8518832af02869d1011e218d232

See more details on using hashes here.

File details

Details for the file roadmapper-1.5.5-py3-none-any.whl.

File metadata

  • Download URL: roadmapper-1.5.5-py3-none-any.whl
  • Upload date:
  • Size: 73.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for roadmapper-1.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 79b99e7ef9f80e2e4684cce7509f3eac907e4fda21020a0ed89595ef77094281
MD5 50ab38607b3536af81bf779bce5a4153
BLAKE2b-256 b8957e643989c2593f10159a85d04edf807d7f602ffc8c764fd8cc6721434b74

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