Mirror/gitinspector
1
0
Fork 0
mirror of https://github.com/ejwa/gitinspector.git synced 2024-12-22 13:42:14 +01:00
Code Issues Projects Releases Packages Wiki Activity
📊 The statistical analysis tool for git repositories
441 commits 3 branches 12 tags 1.7 MiB
Python 94.9%
TeX 3.2%
C++ 1.3%
JavaScript 0.6%
Find a file
Adam Waldenberg d0798d8358 Set ref to HEAD when starting changes analysis i (Fixes #132). 
This gets rid of any invalid refs being set at a subsequent point during
execution.
2017-05-13 15:43:09 +02:00
docs The typo "defaut" should be "default" in documentation (Fixes #113). 2016-07-19 04:04:31 +02:00
gitinspector Set ref to HEAD when starting changes analysis i (Fixes #132). 2017-05-13 15:43:09 +02:00
tests Moved test resouces into a resources directory. 2015-09-05 10:27:29 +02:00
.gitignore Added deb_dist directory to .gitignore. 2013-06-25 14:20:48 +02:00
.pylintrc Global cleanup fixing some pylint violations. 2015-10-05 06:17:10 +02:00
CHANGES.txt Imported CHANGES.txt from most recent extra-release branch. 2015-10-29 01:32:15 +01:00
DESCRIPTION.txt Slightly modified the DESCRIPTION text. 2013-07-29 12:19:32 +02:00
gitinspector.py Added a new gitinspector.py entry script. 2015-10-21 05:07:47 +02:00
LICENSE.txt File structure rearranged to be more compatible with setuptools/Distribute. 2013-06-14 03:16:30 +02:00
MANIFEST.in Translation files are now included during packaging via setup.py. 2013-07-02 07:35:40 +02:00
README.md The typo "defaut" should be "default" in documentation (Fixes #113). 2016-07-19 04:04:31 +02:00
README.txt Added a new gitinspector.py entry script. 2015-10-21 05:07:47 +02:00
setup.py All doc and source code URL's now also point to the new home on GitHub. 2015-08-24 17:34:14 +02:00
stdeb.cfg Added git dependency to stdeb.cfg (it was obviously missing). 2013-07-27 14:05:09 +02:00

README.md

Latest release License

 About Gitinspector

Gitinspector is a statistical analysis tool for git repositories. The default analysis shows general statistics per author, which can be complemented with a timeline analysis that shows the workload and activity of each author. Under normal operation, it filters the results to only show statistics about a number of given extensions and by default only includes source files in the statistical analysis.

This tool was originally written to help fetch repository statistics from student projects in the course Object-oriented Programming Project (TDA367/DIT211) at Chalmers University of Technology and Gothenburg University.

Today, gitinspector is used as a grading aid by universities worldwide.

A full Documentation of the usage and available options of gitinspector is available on the wiki. For help on the most common questions, please refer to the FAQ document.

Some of the features

  • Shows cumulative work by each author in the history.
  • Filters results by extension (default: java,c,cc,cpp,h,hh,hpp,py,glsl,rb,js,sql).
  • Can display a statistical timeline analysis.
  • Scans for all filetypes (by extension) found in the repository.
  • Multi-threaded; uses multiple instances of git to speed up analysis when possible.
  • Supports HTML, JSON, XML and plain text output (console).
  • Can report violations of different code metrics.

Example outputs

Below are some example outputs for a number of famous open source projects. All the statistics were generated using the "-HTlrm" flags.

Project name
Django HTML HTML Embedded Plain Text XML
JQuery HTML HTML Embedded Plain Text XML
Pango HTML HTML Embedded Plain Text XML

The Team

  • Adam Waldenberg, Lead maintainer and Swedish translation
  • Agustín Cañas, Spanish translation
  • Bill Wang, Chinese translation
  • Christian Kastner, Debian package maintainer
  • Jiwon Kim, Korean translation
  • Kamila Chyla, Polish translation
  • Luca Motta, Italian translation
  • Philipp Nowak, German translation
  • Sergei Lomakov, Russian translation
  • Yannick Moy, French translation

We need translations for gitinspector! If you are a gitinspector user, feel willing to help and have good language skills in any unsupported language we urge you to contact us. We also happily accept code patches. Please refer to Contributing for more information on how to contribute to the project.

Packages

The Debian packages offered with releases of gitinspector are unofficial and very simple packages generated with stdeb. Christian Kastner is maintaining the official Debian packages. You can check the current status on the Debian Package Tracker. Consequently, there are official packages for many Debian based distributions installable via apt-get.

License

gitinspector is licensed under the GNU GPL v3. The gitinspector logo is partly based on the git logo; based on the work of Jason Long. The logo is licensed under the Creative Commons Attribution 3.0 Unported License.