Metadata-Version: 2.1
Name: mikado-graph
Version: 0.1.5
Summary: Python tool to draw graphs for Mikado refactoring
Home-page: https://github.com/syrianspock/mikado-graph
Author: Salah Missri
Author-email: syrianspock@gmail.com
License: UNKNOWN
Description: # Mikado Graph
        
        Python tool to draw graphs for Mikado refactoring.
        
        - Learn what is the [Mikado method](https://pragprog.com/magazines/2010-06/the-mikado-method)
        - Learn how to [leverage Mikado graphs in your refactoring tasks](https://www.syrianspock.com/software/2018/07/08/mikado-refactoring/)
        - Python package [hosted on pypi](https://pypi.org/project/mikado-graph/)
        
        ## 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
        ```bash
        pip install mikado-graph
        mikado example.txt --view
        ```
        A new window should display the graph below
        
        ![Example graph](https://raw.githubusercontent.com/SyrianSpock/mikado-graph/master/example.png)
        
        Explore the options using `--help`
        ```bash
        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
        ```bash
        python setup.py sdist bdist_wheel
        twine upload dist/*
        ```
        
        ## Known issues
        
        - `graphviz` will always save a temporary file when asked to render the graph.
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
