Metadata-Version: 2.1
Name: cmd-call-graph
Version: 0.1.1
Summary: A simple tool to generate a call graph for calls within Windows CMD (batch) files.
Home-page: https://github.com/Microsoft/cmd-call-graph
Author: Andrea Spadaccini
Author-email: andrea.spadaccini@gmail.com
License: UNKNOWN
Description: # cmd-call-graph
        A simple tool to generate a call graph for calls within Windows CMD (batch) files.
        
        It takes the input file as stdin and outputs the resulting file to stdout,
        outputting logs and errors to stderr.
        
        Usage example from WSL (Windows Subsystem for Linux):
        
            $ python3 cmd-call-graph.py < your-file.cmd > your-file-call-graph.dot 2>log
        
        The resulting `dot` file can be rendered with any `dot` renderer. Example with
        graphviz:
        
            $ sudo apt install graphviz
            $ dot -Tpng your-file-call-graph.dot > your-file-call-graph.png
            $ explorer.exe your-file-call-graph.png
        
        ## Example
        
        Here is an example CMD script:
        
            @echo off
            call :foo
            goto :eof
            :bar
            echo "in bar"
            call :baz
            call :baz
            :baz
            echo "in baz"
            :foo
            echo "In foo"
            goto :bar
        
        This script would generate the following graph:
        
        ![call graph](https://github.com/Microsoft/cmd-call-graph/raw/master/examples/example1-noshowall.png)
        
        If the `--show-all-calls` option is set to `True`, then the following graph would be generated:
        
        ![call graph showall](https://github.com/Microsoft/cmd-call-graph/raw/master/examples/example1.png)
        
        
        ## Why?
        Sometimes legacy code bases may contain old CMD files. This tool allows to
        generate a visual representation of the internal calls within the script.
        
        ## Contributing
        
        This project welcomes contributions and suggestions.  Most contributions require you to agree to a
        Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
        the rights to use your contribution. For details, visit https://cla.microsoft.com.
        
        When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
        a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
        provided by the bot. You will only need to do this once across all repos using our CLA.
        
        This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
        For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
        contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
        
        ## Unit tests
        Run unit tests from the project root by running:
        
            python3 -m unittest
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: Documentation
Requires-Python: >=2.7, >=3.2
Description-Content-Type: text/markdown
