https://github.com/lowrisc/hjson_to_gantt

A Python script to generate a Gantt chart from a (H)JSON input
https://github.com/lowrisc/hjson_to_gantt

Last synced: 1 day ago
JSON representation

A Python script to generate a Gantt chart from a (H)JSON input

• Host: GitHub
• URL: https://github.com/lowrisc/hjson_to_gantt
• Owner: lowRISC
• License: other
• Created: 2016-10-15T08:37:45.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2016-10-15T10:50:03.000Z (about 8 years ago)
• Last Synced: 2024-08-05T03:30:51.139Z (4 months ago)
• Language: Python
• Size: 43 KB
• Stars: 29
• Watchers: 8
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# hjson_to_gantt

## Introduction

`hjson_to_gantt` is a simple script with a very simple aim: produce a Gantt 

chart based on [(H)JSON input](http://hjson.org/). It is built upon the excellent 

[python-gantt](http://xael.org/pages/python-gantt-en.html) library.

See the accompanying [blog 

post](http://www.lowrisc.org/blog/2016/10/generating-a-gantt-chart-from-hjson-input/)

for a little more motivation.

## Dependencies

`pip install gantt fuzzyfinder hjson`

## Example

    {

      projects: [

        {

          name: Project Alpha

          color: green

        }

      ]

      tasks: [

        {

          name: Design widget

          begin: 2016-10-14

          duration: 7,

          people: Farquaad

          project: alpha

        }

        {

          name: Set up widget production line

          begin: 2016-10-19

          duration: 6

          people: Zack

          project: alpha

        }

        {

          name: Manufacture widgets

          duration: 7

          people: Carrie

          deps: ["design widget", "widget prod line"]

          project: alpha

        }

      ]

      milestones: [

        {

          name: Widgets start shipping

          start: 2016-10-30

          deps: ["mftr widgets"]

          project: alpha

        }

      ]

    }

You'll note that for specifying dependencies and projects, the full name 

doesn't need to be used. Thanks to [fuzzy 

matching](https://github.com/amjith/fuzzyfinder), you can just specify e.g.

"mftr widgets" and have it match "Manufacture widgets".

To try out the example:

`./hjson_to_gantt --begin-date 2016-10-10 --end-date 2016-11-13 example.hjson --name example`

This will output `example_daily.svg` and `example_weekly.svg`.

A PNG rendering of [`example_daily.svg`](example_daily.svg) is shown below (Github doesn't allow embedded SVG):

![Example Gantt chart](example_daily.png?raw=true)

## License

This script is released under the terms of the MIT license (see LICENSE).

However, note that the python-gantt library this script uses is GPLv3+ meaning

the combination is effectively GPLv3+.