-
Notifications
You must be signed in to change notification settings - Fork 10
star grimoire overview
The *Grimoire collection is composed of two tool sets: MetricsGrimoire and VizGrimoire. MetricsGrimoire is the most mature and stable of them. VizGrimoire is mostly stable, but there may be some defects that affect the ability to create results, and is a quickly evolving software, so be prepared for having some issues with them, specially if you are using the latest code.
MetricsGrimoire was born as the LibreSoft toolset (including CVSAnalY, Bicho, MLStats and others) by the LibreSoft research group] at the University Rey Juan Carlos, targeted mainly at researchers. These tools extract information from software development repositories, and organize it into an SQL database.
In 2012, a more open development community was promoted, with the help of a startup company, Bitergia, and it was rebranded as MetricsGrimoire. At about the same time, Bitergia started the vizGrimoire project, to analyze and visualize the data produced by MetricsGrimoire (leading to vizGrimoireR, an R package for analysis, and vizGrimoireJS, a JavaScript platform for visualization).
The combination of MetricsGrimoire and vizGrimoire is referered as *Grimoire. All these tools are free / open source software.
MetricsGrimoire is the core set of tools for mining project data from source code repositories, defect trackers, mailing lists, and other project resources. The name of the project is pronounced: "metrics grim - war"
MetricsGrimoire is broken up into several different components:
- CVSAnaly - extract data from source code repositories, including CVS, Subversion, git, and several others
- Bicho - Extract data from defect tracking systems, including GitHub, Launchpad, and several others
- MailingListStats - Collect information from project mailing lists, can use raw mail mbox files, or talk to a web-based Mailman instance
- CMetrics - Extracts some code metrics (size, complexity, etc) from C code
The second set of tools is used to parse the data in the data base and create more data base tables and entries. Finally the tool set creates a set of json files for use in visualizing the results.
The final tool set is used to display the results. The tools are exported to the web root and json data collected by VizGrimoireR is displayed. This tool set is the most recent.
Each MetricsGrimoire tool has it's own docuementation for installation. Use the README or README.md files on github or in your local copy of the sources.
There is not much documentation (yet) for the other tool sets. This document is an attempt to help remedy that.
Below are the links to the README for each individual tool in Metrics Grimoire.