Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

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

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

Files for mikado-graph, version 0.1.5
Filename, size File type Python version Upload date Hashes
Filename, size mikado_graph-0.1.5-py3-none-any.whl (4.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size mikado_graph-0.1.5.tar.gz (3.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page