Roadmaper - a Roadmap as Code (RaC) Tool

Purpose

As the repo name implies, this purpose of this 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.

Latest version

v.0.1.1

What's new in the latest version of Roadmapper?

• Added colour themes support
• Added the ability to change timeline from actual date to non-specific timeline like Year 1, Year 2, Month 1, Month 2, etc.
• Added the ability to show current date marker on the roadmap
• Fixed defects

Python version requirements:

• Python 3.10+

Library Dependencies

• PyCairo 1.21.0
• Colour 0.1.5
• python-dateutil

Future plans 💡

• Create roadmap with plain english text like PlantUML
• GUI and Web frontend for this roadmapper library
• Visual Studio Code extension to create and edit roadmap
  

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

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

roadmap = Roadmap(1200, 312)
roadmap.set_title("My Demo Roadmap")
roadmap.set_timeline(TimelineMode.MONTHLY, "2023-02-01", 12)

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

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

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

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


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

Output