source: stamper/docs/_build/html/about.html@ 61:8fe64b5932b9

Last change on this file since 61:8fe64b5932b9 was 42:cff2c17bc1d4, checked in by Borja Lopez <borja@…>, 10 years ago

Added initial version of the docs, covering:

  • About stamper
  • Basic installation instructions (missing install from repo or dev env setup, for example)
  • Basic usage instructions (total times, per-day details, timeline, date-based filters and more)
File size: 8.9 KB
RevLine 
[42]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6 <head>
7 <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
9 <title>About Stamper &mdash; Stamper 0.1 documentation</title>
10
11 <link rel="stylesheet" href="_static/default.css" type="text/css" />
12 <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13
14 <script type="text/javascript">
15 var DOCUMENTATION_OPTIONS = {
16 URL_ROOT: './',
17 VERSION: '0.1',
18 COLLAPSE_INDEX: false,
19 FILE_SUFFIX: '.html',
20 HAS_SOURCE: true
21 };
22 </script>
23 <script type="text/javascript" src="_static/jquery.js"></script>
24 <script type="text/javascript" src="_static/underscore.js"></script>
25 <script type="text/javascript" src="_static/doctools.js"></script>
26 <link rel="author" title="About these documents" href="#" />
27 <link rel="top" title="Stamper 0.1 documentation" href="index.html" />
28 <link rel="next" title="Installation instructions" href="install.html" />
29 <link rel="prev" title="Welcome to Stamper’s documentation!" href="index.html" />
30 </head>
31 <body>
32 <div class="related">
33 <h3>Navigation</h3>
34 <ul>
35 <li class="right" style="margin-right: 10px">
36 <a href="genindex.html" title="General Index"
37 accesskey="I">index</a></li>
38 <li class="right" >
39 <a href="install.html" title="Installation instructions"
40 accesskey="N">next</a> |</li>
41 <li class="right" >
42 <a href="index.html" title="Welcome to Stamper’s documentation!"
43 accesskey="P">previous</a> |</li>
44 <li><a href="index.html">Stamper 0.1 documentation</a> &raquo;</li>
45 </ul>
46 </div>
47
48 <div class="document">
49 <div class="documentwrapper">
50 <div class="bodywrapper">
51 <div class="body">
52
53 <div class="section" id="about-stamper">
54<h1><a class="toc-backref" href="#id1">About Stamper</a><a class="headerlink" href="#about-stamper" title="Permalink to this headline"></a></h1>
55<div class="contents topic" id="contents">
56<p class="topic-title first">Contents</p>
57<ul class="simple">
58<li><a class="reference internal" href="#about-stamper" id="id1">About Stamper</a><ul>
59<li><a class="reference internal" href="#from-where-does-it-come-from" id="id2">From where does it come from?</a></li>
60<li><a class="reference internal" href="#enter-the-json" id="id3">Enter the JSON</a></li>
61<li><a class="reference internal" href="#the-tools" id="id4">The tools</a></li>
62</ul>
63</li>
64</ul>
65</div>
66<div class="section" id="from-where-does-it-come-from">
67<h2><a class="toc-backref" href="#id2">From where does it come from?</a><a class="headerlink" href="#from-where-does-it-come-from" title="Permalink to this headline"></a></h2>
68<p><a class="reference external" href="https://bitbucket.org/codigo23/stamper">Stamper</a> was born strongly inspired by the original <a class="reference external" href="http://repos.betabug.ch/stamp">stamp</a> tool written by
69<a class="reference external" href="http://betabug.ch">Sascha Welter</a> (aka <a class="reference external" href="http://betabug.ch">betabug</a>).</p>
70<p>The idea is quite simple:</p>
71<ol class="arabic">
72<li><p class="first">You <strong>stamp</strong> a time in a text file, recording that time as the time when
73you started working on something:</p>
74<div class="highlight-python"><div class="highlight"><pre>2014-08-13 09:45 start
75</pre></div>
76</div>
77</li>
78<li><p class="first">You <strong>stamp</strong> again once you have finished, providing something like an id
79(to identify a customer, project, whatever) and a description of what you
80did:</p>
81<div class="highlight-python"><div class="highlight"><pre>2014-08-13 10:45 stamper writing documentation
82</pre></div>
83</div>
84</li>
85</ol>
86<p>Those times are saved into a text file and afterwards, with a little bit of
87<a class="reference external" href="http://python.org">python</a> magic, you get some reports about the amount of time dedicated per
88day or id (for example).</p>
89</div>
90<div class="section" id="enter-the-json">
91<h2><a class="toc-backref" href="#id3">Enter the JSON</a><a class="headerlink" href="#enter-the-json" title="Permalink to this headline"></a></h2>
92<p>Betabug&#8217;s stamp tool records those times as lines in a text file. This is quite
93convenient because you can look into the file with traditional tools like <em>cat</em>,
94<em>head</em> or <em>tail</em>, or even open it with your favourite editor, and get
95information about the times you&#8217;ve spent working on something.</p>
96<p>But this comes <em>at a cost</em>, it needs some <em>ugly</em> parsing of the .txt file in the
97python code that calculates the statistics and reports, making it difficult/slow
98to perform certain tasks.</p>
99<p><strong>And here it comes JSON:</strong></p>
100<div class="highlight-python"><div class="highlight"><pre>JSON (JavaScript Object Notation) is a lightweight data-interchange format.
101It is easy for humans to read and write. It is easy for machines to parse
102and generate. It is based on a subset of the JavaScript Programming Language,
103Standard ECMA-262 3rd Edition - December 1999. JSON is a text format that is
104completely language independent but uses conventions that are familiar to
105programmers of the C-family of languages, including C, C++, C#, Java,
106JavaScript, Perl, Python, and many others. These properties make JSON an
107ideal data-interchange language.
108</pre></div>
109</div>
110<p>(extracted from <a class="reference external" href="http://json.org">http://json.org</a>)</p>
111<p>Using a .json file instead of a txt file, we can export/import python data
112structures (like lists or dicts) easily into a text-like file. This means that
113we can still edit the file using a text editor, or check its contents using
114<em>cat</em>, <em>head</em> or <em>tail</em>, but we can forget about the parsing of the entries.</p>
115</div>
116<div class="section" id="the-tools">
117<h2><a class="toc-backref" href="#id4">The tools</a><a class="headerlink" href="#the-tools" title="Permalink to this headline"></a></h2>
118<p><a class="reference external" href="https://bitbucket.org/codigo23/stamper">Stamper</a> comes with a variety of tools, but the most used ones are:</p>
119<ul class="simple">
120<li><strong>stamp:</strong> Use this to <em>stamp</em> times into the json file.</li>
121<li><strong>stamps:</strong> USe this to query the json file and obtain information about your
122stamped times.</li>
123</ul>
124<div class="admonition seealso">
125<p class="first admonition-title">See also</p>
126<p class="last">:doc:using</p>
127</div>
128<span class="target" id="json"></span></div>
129</div>
130
131
132 </div>
133 </div>
134 </div>
135 <div class="sphinxsidebar">
136 <div class="sphinxsidebarwrapper">
137 <h3><a href="index.html">Table Of Contents</a></h3>
138 <ul>
139<li><a class="reference internal" href="#">About Stamper</a><ul>
140<li><a class="reference internal" href="#from-where-does-it-come-from">From where does it come from?</a></li>
141<li><a class="reference internal" href="#enter-the-json">Enter the JSON</a></li>
142<li><a class="reference internal" href="#the-tools">The tools</a></li>
143</ul>
144</li>
145</ul>
146
147 <h4>Previous topic</h4>
148 <p class="topless"><a href="index.html"
149 title="previous chapter">Welcome to Stamper&#8217;s documentation!</a></p>
150 <h4>Next topic</h4>
151 <p class="topless"><a href="install.html"
152 title="next chapter">Installation instructions</a></p>
153 <h3>This Page</h3>
154 <ul class="this-page-menu">
155 <li><a href="_sources/about.txt"
156 rel="nofollow">Show Source</a></li>
157 </ul>
158<div id="searchbox" style="display: none">
159 <h3>Quick search</h3>
160 <form class="search" action="search.html" method="get">
161 <input type="text" name="q" />
162 <input type="submit" value="Go" />
163 <input type="hidden" name="check_keywords" value="yes" />
164 <input type="hidden" name="area" value="default" />
165 </form>
166 <p class="searchtip" style="font-size: 90%">
167 Enter search terms or a module, class or function name.
168 </p>
169</div>
170<script type="text/javascript">$('#searchbox').show(0);</script>
171 </div>
172 </div>
173 <div class="clearer"></div>
174 </div>
175 <div class="related">
176 <h3>Navigation</h3>
177 <ul>
178 <li class="right" style="margin-right: 10px">
179 <a href="genindex.html" title="General Index"
180 >index</a></li>
181 <li class="right" >
182 <a href="install.html" title="Installation instructions"
183 >next</a> |</li>
184 <li class="right" >
185 <a href="index.html" title="Welcome to Stamper’s documentation!"
186 >previous</a> |</li>
187 <li><a href="index.html">Stamper 0.1 documentation</a> &raquo;</li>
188 </ul>
189 </div>
190 <div class="footer">
191 &copy; Copyright 2014, Fco. de Borja Lopez Rio, Oscar M. Lage.
192 Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
193 </div>
194 </body>
195</html>
Note: See TracBrowser for help on using the repository browser.