Installation

Select the link for your version and target platform from Github CoatiSoftare Sourcetrail, download extract it and run install.sh:

1
2
3
4
5

$ cd ~/Downloads
$ wget https://github.com/CoatiSoftware/Sourcetrail/releases/download/2020.2.43/Sourcetrail_2020_2_43_Linux_64bit.tar.gz
$ tar -xvf Sourcetrail_2020_2_43_Linux_64bit.tar.gz
$ cd Sourcetrail
$ sudo ./install.sh

This will install Sourcetrail to /opt/sourcetrail/ and makes the command sourcetrail to start the application available via /usr/bin/sourcetrail

1
2
3
4

$ sourcetrail
12:52:36 | LogManager.cpp:40 setLoggingEnabled() | INFO: Enabled logging for Sourcetrail 64 bit, version 2020.2.43
12:52:36 | SharedMemoryGarbageCollector.cpp:59 run() | INFO: start shared memory garbage collection
...

Index a Python Project

Start Sourcetrail with $ sourcetrail and hit “New Project”.

Give your Sourcetrail project a name and a directory where is can locate its project files and databases.

Select the Python source group, give it a name, point it to your virtual environment or Python interpreter executable and finally to your Python project directory.

After hitting create indexing will start.

When done, interactively explore the code …