<div align="center">

Graphical Code Tracer

<p align="center"> <a href="https://pepy.tech/project/gct-py"> <img src="https://static.pepy.tech/badge/gct-py" alt="users"> </a> <a href="https://github.com/QasimWani/gct/blob/main/LICENSE"> <img src="https://img.shields.io/badge/License-GNU%20GPL-green.svg" alt="license"/> </a> <a href="https://pypi.org/project/gct-py"> <img src="https://img.shields.io/pypi/v/gct-py?color=blue" alt="license"/> </a> <a href="https://github.com/QasimWani/gct/graphs/contributors" alt="Contributors"> <img src="https://img.shields.io/github/contributors/QasimWani/gct" /> </a> <a target="_blank" href="https://twitter.com/intent/tweet?text=GCT is a code visualization tool that generates a graphical representation of any python program! Try it out: https://gctpy.com" class="item"> <img src="https://img.shields.io/twitter/url?label=Tweet&amp;style=social&amp;url=https://gctpy.com"> </a> </p>

Graphical Code Tracer (gct) is the world's first visual static code analyzer.

Within seconds it can tell you how your functions and classes are connected to each other!

Getting started • Installation • Configuration

</div>

Getting started

Usecases:

1. Onboard to new codebases faster.
2. Debug code faster Twitter thread
3. Create share-able versions of your code. Using gctpy.com, you can instantly share your UML diagrams across teams.

Generate graph for any python file

python -m gct -i path/to/file.py # run gct on a local file
python -m gct -i https://github.com/user_name/path/to/file.py # run gct on a file hosted on a web server

Installation

Step 1: Install GCT Python package

pip install gct-py

Step 2: Install Graphviz executable

GCT generates graphs using graphviz. To get accurate graphs, we highly recommend using latest graphviz version available for your OS.

Skip this step if you've already installed graphviz executable version. Check the dot version by running: dot -V.

<details> <summary>Windows</summary>

Install graphviz by downloading executable (version >=6.0.1) from graphviz website.

</details> <details> <summary>MacOS</summary>

(Optional) more details: graphviz.

  brew install graphviz

</details> <details> <summary>Linux</summary>

(optional) more details: graphviz.

  sudo apt install graphviz

</details>

Configuration

Customize the experience by aliasing gct:

alias gct='python -m gct -i'
gct path/to/file.py