From 319070c15a5d395171708cf1c1d679f47513d089 Mon Sep 17 00:00:00 2001 From: Adam Waldenberg Date: Fri, 14 Jun 2013 05:08:22 +0200 Subject: [PATCH] Added a DESCRIPTION.txt used for the long description in setup.py. --- DESCRIPTION.txt | 10 ++++++++++ setup.py | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) create mode 100644 DESCRIPTION.txt diff --git a/DESCRIPTION.txt b/DESCRIPTION.txt new file mode 100644 index 0000000..eacd7ab --- /dev/null +++ b/DESCRIPTION.txt @@ -0,0 +1,10 @@ +gitnspector is a statistical analysis tool for git repositories. The defaut 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. + +- Shows cumulative work by each author in the history. +- Filters results by extension (default: java,c,cpp,h,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 and XML output as a complement to the terminal support. diff --git a/setup.py b/setup.py index 6665e3c..5e4f627 100644 --- a/setup.py +++ b/setup.py @@ -34,7 +34,7 @@ setup( license = "GNU GPL v3", keywords = "analysis analyzer git python statistics stats vc vcs timeline", url = "http://gitinspector.googlecode.com", - long_description = read("README.txt"), + long_description = read("DESCRIPTION.txt"), classifiers = [ "Development Status :: 4 - Beta", "Environment :: Console",