User Tools

Site Tools


chaoss:gsoc-ideas

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Last revision Both sides next revision
chaoss:gsoc-ideas [2018/02/27 15:35]
GeorgLink
chaoss:gsoc-ideas [2018/03/04 13:34]
GeorgLink change order
Line 5: Line 5:
  
  
- +===== Idea #1: Prototype New CHAOSS Metrics ​ =====
-=====  Idea #1: Reporting of CHAOSS Metrics ===== +
- +
-[ [[https://​github.com/​chaoss/​grimoirelab/​issues/​70|Micro-tasks and place for questions]] ] +
- +
-Currently, [[https://​grimoirelab.github.io/​|GrimoireLab]] includes a tool for reporting: Manuscripts. This tool reads data from a GrimoireLab ElasticSearch database, and produces with it a PDF report with relevant metrics for a set of analyzed projects. Internally, Manuscripts uses some Python code to produce charts and CSV tables, which are integrated into a LaTeX document to produce the final PDF. Other approaches, such as producing Jupyter notebooks, will be explored too. +
- +
-This idea is about adding support to Manuscripts to produce reports based on the work of the CHAOSS Community. Since Manuscripts is still a moving target, this will be also a chance to participate in the general development of the tool itself, to convert it into a generic reporting system for GrimoireLab data. +
- +
-The aims of the project are as follows:  +
- +
-  * Writing Python code to query GrimoireLab Elastisearch databases and obtain from it the metrics relevant for the report. Possible technologies to achieve this aim include Python Pandas. +
-  * Writing Python code to produce suitable representation for those metrics, such as tables and charts. +
-  * Adapting current tools to produce reports directly from data sources, by managing the GrimoireLab toolchain. Possible solutions include adding the code to Mordred, the tool orchestrating GrimoireLab tools. +
- +
-Other aims, such as producing Jupyter notebooks as a final result or an intermediate step are completely within scope. +
- +
-  * //​Difficulty://​ easy/​medium +
-  * //​Requirements://​ Python programming. Interest in software analytics. Willingness to understand GrimoireLab internals. +
-  * //​Recommended://​ Experience with Python interfaces to databases would be convenient, but can be learned during the project. Experience with Latex and/or Python Jupyter Notebooks would help. +
-  * //​Mentors://​ Jesus M. Gonzalez-Barahona,​ Matt Germonprez, Jordi Cabot +
- +
- +
-===== Idea #2: Prototype New CHAOSS Metrics ​ =====+
  
 [ [[https://​github.com/​OSSHealth/​ghdata/​issues/​82|Micro-tasks and place for questions]] ] [ [[https://​github.com/​OSSHealth/​ghdata/​issues/​82|Micro-tasks and place for questions]] ]
Line 58: Line 35:
  
  
-===== Idea #3: Support of Standard CHAOSS Formats for Description of Projects =====+===== Idea #2: Support of Standard CHAOSS Formats for Description of Projects =====
  
 [ [[https://​github.com/​chaoss/​grimoirelab/​issues/​71|Micro-tasks and place for questions]] ] [ [[https://​github.com/​chaoss/​grimoirelab/​issues/​71|Micro-tasks and place for questions]] ]
Line 81: Line 58:
   * //​Recommended://​ Experience with Python HTTP and XML libraries would be convenient, but can be learned during the project.   * //​Recommended://​ Experience with Python HTTP and XML libraries would be convenient, but can be learned during the project.
   * //​Mentors://​ Jesus M. Gonzalez-Barahona,​ Valerio Cosentino   * //​Mentors://​ Jesus M. Gonzalez-Barahona,​ Valerio Cosentino
 +
 +
 +
 +=====  Idea #3: Reporting of CHAOSS Metrics =====
 +
 +[ [[https://​github.com/​chaoss/​grimoirelab/​issues/​70|Micro-tasks and place for questions]] ]
 +
 +Currently, [[https://​grimoirelab.github.io/​|GrimoireLab]] includes a tool for reporting: Manuscripts. This tool reads data from a GrimoireLab ElasticSearch database, and produces with it a PDF report with relevant metrics for a set of analyzed projects. Internally, Manuscripts uses some Python code to produce charts and CSV tables, which are integrated into a LaTeX document to produce the final PDF. Other approaches, such as producing Jupyter notebooks, will be explored too.
 +
 +This idea is about adding support to Manuscripts to produce reports based on the work of the CHAOSS Community. Since Manuscripts is still a moving target, this will be also a chance to participate in the general development of the tool itself, to convert it into a generic reporting system for GrimoireLab data.
 +
 +The aims of the project are as follows: ​
 +
 +  * Writing Python code to query GrimoireLab Elastisearch databases and obtain from it the metrics relevant for the report. Possible technologies to achieve this aim include Python Pandas.
 +  * Writing Python code to produce suitable representation for those metrics, such as tables and charts.
 +  * Adapting current tools to produce reports directly from data sources, by managing the GrimoireLab toolchain. Possible solutions include adding the code to Mordred, the tool orchestrating GrimoireLab tools.
 +
 +Other aims, such as producing Jupyter notebooks as a final result or an intermediate step are completely within scope.
 +
 +  * //​Difficulty://​ easy/medium
 +  * //​Requirements://​ Python programming. Interest in software analytics. Willingness to understand GrimoireLab internals.
 +  * //​Recommended://​ Experience with Python interfaces to databases would be convenient, but can be learned during the project. Experience with Latex and/or Python Jupyter Notebooks would help.
 +  * //​Mentors://​ Jesus M. Gonzalez-Barahona,​ Matt Germonprez, Jordi Cabot
 +
 +
chaoss/gsoc-ideas.txt · Last modified: 2018/03/21 15:56 by GeorgLink