Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/qasimwani/gct
Graphical Code Tracer (GCT): Visualize code at lightning speed
https://github.com/qasimwani/gct
ast graphviz python static-code-analysis visualization
Last synced: about 2 months ago
JSON representation
Graphical Code Tracer (GCT): Visualize code at lightning speed
- Host: GitHub
- URL: https://github.com/qasimwani/gct
- Owner: QasimWani
- License: gpl-3.0
- Created: 2022-12-11T07:01:17.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-02-05T22:39:46.000Z (almost 2 years ago)
- Last Synced: 2024-04-24T01:02:21.209Z (8 months ago)
- Topics: ast, graphviz, python, static-code-analysis, visualization
- Language: Python
- Homepage: https://www.gctpy.com
- Size: 2.24 MB
- Stars: 46
- Watchers: 2
- Forks: 9
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Graphical Code Tracer
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](#getting-started) •
[Installation](#installation) •
[Configuration](#configuration)
## Getting started
### Usecases:
1. Onboard to new codebases faster.
2. Debug code faster [Twitter thread](https://twitter.com/qasim31wani/status/1609677492347981825)
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
```sh
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](https://graphviz.org). 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`.
Windows
Install graphviz by downloading executable (version >=6.0.1) from [graphviz](https://graphviz.org/download/#windows) website.
MacOS
(Optional) more details: [graphviz](https://graphviz.org/download/#mac).
```
brew install graphviz
```
Linux
(optional) more details: [graphviz](https://graphviz.org/download/#linux).
```
sudo apt install graphviz
```
## Configuration
Customize the experience by aliasing `gct`:
```
alias gct='python -m gct -i'
gct path/to/file.py
```