doc/README_txt.html
<!DOCTYPE html>
<html>
<head>
<meta content="text/html; charset=ASCII-8BIT" http-equiv="Content-Type">
<title>README - git_time_extractor-0.2.0 Documentation</title>
<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
<script type="text/javascript">
var rdoc_rel_prefix = "./";
</script>
<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
<body class="file">
<nav id="metadata">
<nav id="home-section" class="section">
<h3 class="section-header">
<a href="./index.html">Home</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
</h3>
</nav>
<nav id="search-section" class="section project-section" class="initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<h3 class="section-header">
<input type="text" name="search" placeholder="Search" id="search-field"
title="Type to search, Up and Down to navigate, Enter to load">
</h3>
</form>
<ul id="search-results" class="initially-hidden"></ul>
</nav>
<div id="project-metadata">
<nav id="fileindex-section" class="section project-section">
<h3 class="section-header">Pages</h3>
<ul>
<li class="file"><a href="./History_txt.html">History</a>
<li class="file"><a href="./Manifest_txt.html">Manifest</a>
<li class="file"><a href="./README_txt.html">README</a>
</ul>
</nav>
<nav id="classindex-section" class="section project-section">
<h3 class="section-header">Class and Module Index</h3>
<ul class="link-list">
<li><a href="./GitTimeExtractor.html">GitTimeExtractor</a>
</ul>
</nav>
</div>
</nav>
<div id="documentation" class="description">
<h1 id="label-git_time_extractor">git_time_extractor</h1>
<p>RubyGem Page: <a
href="https://rubygems.org/gems/git_time_extractor">rubygems.org/gems/git_time_extractor</a>
Project Wiki: <a
href="https://github.com/rietta/git_time_extractor/wiki">github.com/rietta/git_time_extractor/wiki</a></p>
<h2 id="label-DESCRIPTION%3A">DESCRIPTION:</h2>
<p>EXTRACT REASONABLE TIME RECORDS FROM A GIT REPOSITORY</p>
<p>git_time_extractor is a free tool that goes through a GIT, the popular
revision control system, repository's commit log and produces a Comma
Separated Values (CSV) file that indicates the time spent by each
developer, per day.</p>
<p>The working time estimates are based on three assumptions:</p>
<pre>1. A series of commits within a 3 hour window are part of the same development session
2. A single commit (or the first commit of the session) is considered to represent 30 minutes of work time
3. The more frequent a developer commits to the repository while working, the more accurate the time report will be</pre>
<p>This script is based on previous code published publicly by Sharad at <a
href="http://www.tatvartha.com/2010/01/generating-time-entry-from-git-log/.">www.tatvartha.com/2010/01/generating-time-entry-from-git-log/.</a>
However, it has been adapted to run without Rails from the command line.
The portions of the code written by Rietta are licensed under the terms of
the BSD license (see section 3 below).</p>
<p>git_time_extractor is useful for software development companies that want
to discover the approximate time spent by developers on particular projects
based on real data in the GIT revision control system. This is useful for
managers, accountants, and for those who need to back up records for tax
purposes.</p>
<p>For example, in the United States there is a Research & Development
(R&D) tax credit available for companies who build or improve software
for certain purposes. To claim this credit requires certain types of
records. Check with your accountant to see if the results from this
program is appropriate in your particular situation. You can learn more
information about this particular credit at <a
href="http://www.irs.gov/businesses/article/0,,id=156366,00.html.">www.irs.gov/businesses/article/0,,id=156366,00.html.</a></p>
<h2 id="label-BENEFITS%3A">BENEFITS:</h2>
<pre>* Compute time records based on the timestamps of each code commit by each developer
* Compare these results with other time-sheets or metrics to measure the effectiveness of your team members
* Save money on taxes by producing documents required by your accountant to properly apply for certain tax credits
* It's a Free Open Source Tool</pre>
<h2 id="label-FEATURES%3A">FEATURES:</h2>
<pre>* Easy command-line operation
* Reads from a local GIT branch in the current directory
* Writes to a CSV-file that is compatible with Microsoft Excel, OpenOffice Calc, or Google Docs</pre>
<h2 id="label-SYNOPSIS%3A">SYNOPSIS:</h2>
<pre>cd /path/to/your/repository
git_time_extractor > time_log.csv</pre>
<h2 id="label-REQUIREMENTS%3A">REQUIREMENTS:</h2>
<pre>The following GEMS are required as dependencies:
* git
* logger</pre>
<h2 id="label-INSTALL%3A">INSTALL:</h2>
<pre>gem install git_time_extractor</pre>
<h2 id="label-UNINSTALL%3A">UNINSTALL:</h2>
<pre>gem install git_time_extractor</pre>
<h2 id="label-DEVELOPERS%3A">DEVELOPERS:</h2>
<p>After checking out the source, run:</p>
<pre>$ rake newb</pre>
<p>This task will install any missing dependencies, run the tests/specs, and
generate the RDoc.</p>
<h2 id="label-LICENSE%3A">LICENSE:</h2>
<p>(The BSD License)</p>
<p>Copyright (c) 2012 Rietta Inc. All rights reserved.</p>
<p>Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:</p>
<p>Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer. Redistributions in binary
form must reproduce the above copyright notice, this list of conditions and
the following disclaimer in the documentation and/or other materials
provided with the distribution.</p>
<p>THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.</p>
</div>
<footer id="validator-badges">
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>