Skip to main content

Python tool to draw graphs for Mikado refactoring

Project description

Mikado Graph

Python tool to draw graphs for Mikado refactoring.


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

Example graph

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 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.5.tar.gz (3.8 kB view hashes)

Uploaded source

Built Distribution

mikado_graph-0.1.5-py3-none-any.whl (4.2 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page