Python tool to draw graphs for Mikado refactoring
Project description
Mikado Graph
Python tool to draw graphs for Mikado refactoring.
Quickstart
Start by saving this description file as as example.txt
_ Extend X with Y
x Remove flag Z from X
x Replace D with E
x Check C
# Ignore this line
_ Add field X in Y
x Do fix A
_ Add B
x Check C
Then run
pip install mikado-graph
mikado example.txt --view
A new window should display the graph below
Explore the options using --help
mikado --help
And learn more about the description file format below.
Graph description symbols
Parent/child dependency is encoded by indentation.
There are three kinds of nodes in the graph
- Comments are prefixed by one of the following symbol:
//
,#
- Done tasks (drawn in green) are prefixed by one of the following symbols:
v
,V
,x
,X
- Pending tasks (drawn in red) are prefixed by any symbol that is not used by the above two choices.
We recommend using
_
to keep the description file human readable
Dev & Deploy
Deploy by running
python setup.py sdist bdist_wheel
twine upload dist/*
Known issues
graphviz
will always save a temporary file when asked to render the graph.
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
mikado_graph-0.1.3.tar.gz
(3.6 kB
view hashes)
Built Distribution
Close
Hashes for mikado_graph-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7961a4833863b3ebfdcec0e68f4693c3fd7c8f362cedbf19cc2313edebd43be0 |
|
MD5 | 884482ca85dea5f20705aad426af196a |
|
BLAKE2b-256 | 7eabe4143b0cb3040a179d2c28a9636060475dee0263148a7ecee79eb7ed3594 |