Source-o-grapher Tool 
Source-o-grapher is a tool built with the aim to investigate software resilience aspects of Open Source Software (OSS) projects. The tool uses several metrics from the literature to evaluate an OSS project on four major dimensions: structural (source code), business and legal, integration and social (community of the project). Many of these metrics are automatically acquired by the tool using the Github repository of the project whereas some others are manually input by the expert who performs the analysis.
Requirements & Installation
Step 1: Install all the requirements before proceeding to next steps:
- Python >= 3.5
- python3-pandas >= 0.22
- python3-numpy >= 1.13.3
- python3-matplotlib >= 2.1.1
- python3-PyGithub (see Useful Links section)
- python3-tkinter >= 8.6
- python3-xml.etree.ElementTree >= 1.3
You should install all the python3 modules using the pip3 install *package_name* command.
(or alternatively using: sudo apt-get install python3-*package_name* conmmand)
Step 2: Install integrated tools:
- Install the PHPQA (version 1.19) tool through the bash script
phpqa_installation.shfound in the bash_scripts folder.
To run phpqa's script you need to have: composer (see Useful Links section) and the php-xsl extension installed (sudo apt-get install php7.2-xls).
More tools to be added in the future.
Running the tool
In order to successfully run the tool you need to:
- Clone (git clone) or download the project.
- Generate a personal Github API token using the guide included in the Useful Links section.
- Insert the generated token in the
/sourceographer/githubAPI_testers/github_APIInfo.pyscript on line 6. - Run Sourceographer by using the command
python3 flowcontroller.pywhile being in githubAPI_testers folder. - Check the results in the outputs folder.
Note #1: The first three steps must be executed only once: the first time you are going to use Sourceographer.
Note #2: Before executing the flowcontroller.py script, make sure that the indicators.csv and input_metrics.csv files are blank, containing only the column names with no data added.
Theoretical basis
This tool was designed following the theoretical basis of the Resilience Framework for OSS that was first introduced to the following academic work:
Kritikos A., Stamelos I. (2018) Open Source Software Resilience Framework. In: Stamelos I., Gonzalez-Barahoña J., Varlamis I., Anagnostopoulos D. (eds) Open Source Systems: Enterprise Software and Solutions. OSS 2018. IFIP Advances in Information and Communication Technology, vol 525. Springer, Cham. https://doi.org/10.1007/978-3-319-92375-8_4
A detailed description of the full framework is available here.
Useful Links
- PyGithub lib repo: https://github.com/PyGithub/PyGithub
- Composer installation guide: https://www.digitalocean.com/community/tutorials/how-to-install-and-use-composer-on-ubuntu-18-04
- PHPQA (v1.19) Github repo: https://github.com/EdgedesignCZ/phpqa/tree/v1.19.0
- Generating a Github API token guide: https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line
633 Dec 23, 2022
87 Dec 27, 2022
12 Aug 8, 2022
7 Oct 4, 2022
6.2k Jan 1, 2023
2.4k Jan 7, 2023
1 Oct 22, 2021
4 Oct 27, 2021
1 Mar 13, 2022
1 Aug 29, 2022
2 Jan 23, 2022
8 Dec 26, 2022
1 Oct 17, 2022
1 Dec 04, 2021
1 Nov 14, 2022
5 Feb 06, 2022
10 Oct 03, 2021
1 Nov 02, 2021
45 Mar 28, 2022
2 May 04, 2022
22 Nov 15, 2022
6 May 21, 2022
3 Jan 09, 2022
455 Dec 24, 2022
12.1k Jan 08, 2023
45 Nov 24, 2022
1 Mar 05, 2022
25 Dec 30, 2022
90 Jan 05, 2023