search

MetricsGrimoire / CVSAnalY

The CVSAnalY tool extracts information out of source code repository logs and stores it into a database.
http://metricsgrimoire.github.com/CVSAnalY/
GNU General Public License v2.0
48 stars 31 forks source link

readme

CVSAnaly Build Status

Description

The CVSAnalY tool extracts information out of source code repository logs and stores it into a database.

License

Licensed under GNU General Public License (GPL), version 2 or later.

Download

Requirements

CVSAnalY has the following dependencies:

Scripts

Some useful scripts for performing reseach studies (activity, generations, etc) can be found in the next link:

    http://git.libresoft.es/libcvsanaly2

You can get the code from the git repository:

    git clone git://git.libresoft.es/git/libcvsanaly2
    git clone http://git.libresoft.es/libcvsanaly2

Installation

You can install cvsanaly2 just by running setup.py script:

# python setup.py install

This will install it in the python default directories in your system.

If you don't install CVSAnalY with root privileges, or don't want to install it in the default directories, you can also use the source code directory, as cloned from the main git repo. It is enough to configure your PATH and PYTHONPATH so that cvsanaly2, and the Python modules it needs, are found.

Add to your $PATH the directory which contains cvsanaly (cvsanalydir is the directory where CVSAnalY is installed):

$ export PATH=$PATH:cvsanalydir

In PYHTONPATH, you need to include both the dirs for CVSAnalY and RepositoryHandler (except if it is installed in the default Python dirs in your system). If repohandlerdir is the path where RepositoryHandler is installed:

$ export PYTHONPATH=$PYTHONPATH:cvsanalydir:repohandlerdir

You are ready to use cvsanaly2!

Running cvsanaly2

For the impatients: just checkout (from svn or cvs) to obtain a local version of your repository, and then run cvsanaly2:

$ cd project/
~/project$ cvsanaly2

More options, and a more detailed info about the options, can be learnt by running "cvsanaly2 --help"

Useful settings

Extensions

You can extend CVSAnalY with various extensions. Some extenstions are delivered with the application itselfs.

Metrics

The goal of the metrics extension is to collect various programing language related metrics like lines of code, McCabe and so on. To enable the full feature set of this extension please be sure that the following programs are installed on your system:

Improving CVSAnalY

Source code, wiki and ITS available on Github: https://github.com/MetricsGrimoire/CVSAnalY

If you want to receive updates about new versions, and keep in touch with the development team, consider subscribing to the mailing list. It is a very low traffic list (< 1 msg a day): https://lists.libresoft.es/listinfo/metrics-grimoire

Credits

CVSAnalY was initially developed by the GSyC/LibreSoft group at the Universidad Rey Juan Carlos, Madrid (Spain). It is part of a wider research on libre software engineering, aimed to gain knowledge on how libre software is developed and maintained.

Main authors

Contributors