gerald1248 / kanban-builder

generator for markdown task boards

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Kanban builder

A word of warning: this is as niche as it gets. Imagine the following scenario:

  • you want to share a Kanban board with your team
  • there's no Trello, Jira, Rally, Dashing, nothing
  • even if you're prepared to put up with a single user spreadsheet your users can't get to it easily

What you do have is a VCS, so you decide to use the one file you can manipulate easily: the one and only README.md.

Now if you find you'd like to drop a Git(Hub|Lab|NextCoolThing) flavoured Markdown table in there, you may find this Kanban builder useful.

Usage

$ python [relative/path/to/]kanban_builder.py [input.yml]

Arguments:
--rows=N: display no more than N rows (default is 20)
--help/-h: display this text

Sample YAML input

- 'To do':
  - A
  - B
  - C is longer than B
- 'Doing':
  - D
  - E 
  - F 
- 'Done':
  - G
  - H
  - I 

Sample output

To do Doing Done
A D G
B E H
C is longer than B F I

Output source

|**To do**         |**Doing**|**Done**|
|:-----------------|:--------|:-------|
|A                 |D        |G       |
|B                 |E        |H       |
|C is longer than B|F        |I       |

Build

$ virtualenv ve
$ source ve/bin/activate
$ pip install pybuilder
$ pyb install_dependencies
$ pyb

Exceedingly rarely asked questions

Q: What have I gained?

A: Let's say you want to move 'C is longer than B' from 'To do' to 'Doing'. With kanban-builder you would open the input YAML in vi and type:

4Gddp:x

To achieve the same by editing the markdown source, you would need to jump into visual mode and:

  • cut out 'C is longer than B'
  • add a new row at the bottom of the table
  • shunt down 'D', 'E' and 'F'
  • insert 'C is longer than B' at the top of the Doing column
  • adjust the column widths
  • despair

About

generator for markdown task boards

License:MIT License


Languages

Language:Python 100.0%