Skip to main content

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

Project description

Roadmap Generator - 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.

Current version

v.0.1.0-beta1

Python version requirements:

  • Python 3.10+

Library Dependencies

  • PyCairo 1.21.0
  • Colour 0.1.5

Installation

Install from PyPI

pip install roadmap-generator

Documentation

Please refer to Roadmap Generator Guide (coming soon) for more information on how to use this RaC library.


Code Example

roadmap = Roadmap(1200, 312)
roadmap.set_title("My Demo Roadmap")
roadmap.set_timeline(TimelineMode.MONTHLY, "2023-02-01", 12)
with roadmap.add_group("Core Product Work Stream") as group:
    with group.add_task("Base Functionality", "2022-11-01", "2023-10-31") as task:
        task.add_milestone("v.1.0", "2023-02-15")
        task.add_milestone("v.1.1", "2023-08-01")
        task.add_milestone("v.1.2", "2023-09-30")
    with task.add_parellel_task("Enhancements", "2023-11-15", "2024-03-31") as task1a:
        task1a.add_milestone("v.2.0", "2024-03-30")
    with group.add_task("Showcase #1", "2023-03-01", "2023-05-07") as task:
        with task.add_parellel_task("Showcase #2", "2023-06-01", "2023-08-07") as parellel_task:
            pass

with roadmap.add_group("Mobility Work Stream") as group:
    with group.add_task("Mobile App Development", "2023-02-01", "2024-12-07") as task:
        task.add_milestone("iOS App", "2023-04-15")
        task.add_milestone("Android App", "2023-09-07")

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

Output

name

Timeline can be changed by changing the mode

Quarterly Mode:

roadmap.set_timeline(TimelineMode.QUARTERLY, "2023-02-01", 4)

Output

name

Other timeline modes available are:

  • TimelineMode.WEEKLY
  • TimelineMode.MONTHLY
  • TimelineMode.QUARTERLY
  • TimelineMode.HALF_YEARLY
  • TimelineMode.YEARLY

Font, font size, font colour and fill colour can be changed

# Uses default colour scheme, font and font size
roadmap.set_title("My Demo Roadmap")

# Change font colour, but use default font and font size
roadmap.set_title("My Demo Roadmap", font_colour="Salmon")

# Change font colour, font and font size
roadmap.set_title("My Demo Roadmap", font_colour="Salmon", font="Arial", font_size=18)

Output

name



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

roadmap-generator-0.1.0b2.tar.gz (15.5 kB view details)

Uploaded Source

Built Distribution

roadmap_generator-0.1.0b2-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

Details for the file roadmap-generator-0.1.0b2.tar.gz.

File metadata

  • Download URL: roadmap-generator-0.1.0b2.tar.gz
  • Upload date:
  • Size: 15.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.8

File hashes

Hashes for roadmap-generator-0.1.0b2.tar.gz
Algorithm Hash digest
SHA256 c695575aeda9ac38d4144778d9759e0702634bb3a4a8fc6394167aabae42ca71
MD5 56d91fe8b684315d32f9c4c0fe884ff5
BLAKE2b-256 0942a94a42e1aae8d62cf18453b34eda67ba30f04381f36c6d1083145cc6856b

See more details on using hashes here.

File details

Details for the file roadmap_generator-0.1.0b2-py3-none-any.whl.

File metadata

File hashes

Hashes for roadmap_generator-0.1.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 0a44db75c6cc052773a73179bbaa81860971970954d38585546208e87e79ee9b
MD5 fd1950fe9b1275d963f0f1bee6e959ed
BLAKE2b-256 b4dc01e1567189dcc76d7286fbd2dc9519b7b139199f29fa51ebac5b25fc5f56

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