Usage Documentation

Steps to create a roadmap

Step 1: Import Roadmap and TimelineMode package

from generator.roadmap import Roadmap
from generator.timelinemode import TimelineMode

Step 2: Create a Roadmap instance.

my_roadmap = Roadmap(width=500, height=300)

Step 3: Configure roadmap title and timeline

my_roadmap.set_title("My Roadmap")
my_roadmap.set_timeline(mode=TimelineMode.MONTHLY, start="2022-11-14", number_of_items=6)

Step 4: Add group and task(s) to the roadmap

with my_roadmap.add_group("Development") as group:
    with group.add_task("Activity 1", "2022-12-01", "2023-02-10") as task:
        pass

You can add more tasks by calling add_task() method multiple time.

    with group.add_task("Activity 2", "2023-01-11", "2023-03-20") as task:
        pass
    with group.add_task("Activity 3", "2023-01-21", "2023-06-30") as tasks:
        pass

Step 5: Configure footer

my_roadmap.set_footer("Generated by Roadmap Generator")

Step 6: Render the roadmap

my_roadmap.draw()

Step 7: Save the roadmap to a PNG file format

my_roadmap.save("my_roadmap.png")