Changeset 44:5f48fc9d6e7d in stamper

Timestamp:

Aug 14, 2014, 9:17:17 AM (10 years ago)

Author:

Borja Lopez <borja@…>

Branch:

default

Phase:

public

Message:

Added charts generation documentation

Added information on how to get the list of full arguments on the command
line for the stamps tool

Location:

docs

Files:

• _build/doctrees/environment.pickle (modified) ( previous)
• _build/doctrees/using.doctree (modified) ( previous)
• _build/html/_sources/using.txt (modified) (2 diffs)
• _build/html/index.html (modified) (1 diff)
• _build/html/searchindex.js (modified) (1 diff)
• _build/html/using.html (modified) (4 diffs)
• using.rst (modified) (2 diffs)

docs/_build/html/_sources/using.txt

@@ -131 +131 @@
 
 
-
-
-Full List of arguments
-++++++++++++++++++++++
+Charts
+++++++
+
+You can generate some nice charts from your stamps. So far only bar charts
+showing the total time per day can be generated, but you can filter them by
+**ID** and/or date. Some examples:
+
+- Render a chart of all the times already stamped, by **ID**::
+
+    stamps -g
+
+- Render a chart of the stamps for the last 4 days::
+
+    stamps -g 4d
+
+- Render a chart of the stamps for the **ID** *stamper* for the last week::
+
+    stamps -g stamper 1w
+
+.. note::
+
+   The charts will be saved into **~/.workstamps-charts**, in SVG_ format.
+   The name of the chart will be generated based on the current date and
+   time, and a *symbolic link* called **chart-latest.svg** will be created,
+   pointing to the latest chart generated.
+
+
+stamps - full List of arguments
+-------------------------------
+
+You can get the full list of arguments from the command line too::
+
+  stamps -h
+
+or::
+
+  stamps --help
 
 .. argparse::
@@ -188 +221 @@
 
 
+.. _SVG: http://en.wikipedia.org/wiki/Scalable_Vector_Graphics
+
 .. [1] http://repos.betabug.ch/stamp

docs/_build/html/index.html

@@ -64 +64 @@
 <li class="toctree-l2"><a class="reference internal" href="using.html#recording-time">Recording time</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using.html#retrieving-information-from-the-existing-stamps">Retrieving information from the existing stamps</a></li>
+<li class="toctree-l2"><a class="reference internal" href="using.html#stamps-full-list-of-arguments">stamps - full List of arguments</a></li>
 <li class="toctree-l2"><a class="reference internal" href="using.html#date-based-filtering">Date-based filtering</a></li>
 </ul>

docs/_build/html/searchindex.js

@@ -1 @@
-Search.setIndex({envversion:42,terms:{all:3,code:1,identifi:[3,1],forget:1,just:[3,2],show:3,perl:1,text:[3,1],offici:0,verbos:3,becaus:1,interchang:1,human:1,follow:3,still:1,import_fil:3,languag:1,onli:3,slow:1,group:3,cli:3,easi:[1,2],also:3,graph:3,welter:1,ideal:1,littl:1,tail:1,program:1,dict:1,queri:1,save:1,bebu:3,inspir:1,"return":3,string:3,get:[3,1],python:[0,1,2],familiar:1,pypi:2,dai:1,obtain:1,repo:3,know:2,report:1,bit:1,month:3,sascha:1,betabug:[3,1],magic:1,like:1,chang:3,did:[3,1],list:1,entri:1,easili:1,statist:1,each:3,januari:3,record:1,page:0,mean:1,subset:1,work:[3,1],timelin:[],some:[3,1,2],idea:1,born:1,cost:1,"export":1,result:3,year:3,extract:1,even:1,index:0,what:[3,1],insensit:3,learn:3,"3rd":1,space:3,open:1,someth:1,calcul:1,per:1,delet:3,written:[0,1],between:3,"import":[3,1],experi:2,ref:3,can:[3,1],machin:1,afterward:1,full:[],august:3,usag:3,gener:[3,1],javascript:1,situat:3,here:1,standard:[1,2],base:1,org:[1,2],sinc:3,search:0,last:3,convent:1,befor:3,keep:3,filter:[],etc:2,amount:1,tutori:2,fals:3,mani:1,implement:3,other:[3,1],ecma:1,first:3,origin:1,yyyi:3,rang:3,simpli:3,appli:3,modul:[0,2],independ:1,easy_instal:2,yourself:3,instruct:[],alreadi:2,famili:1,instal:[],next:3,miss:3,your:[3,1,2],quit:[1,2],given:3,java:1,wai:3,stamp:1,custom:[3,1],avail:2,start:[3,1],editor:1,handl:3,txt:1,conveni:1,store:3,includ:[3,1],tradit:1,head:1,option:3,difficult:1,juli:3,edit:1,ani:3,pars:1,line:[3,1],those:[3,1],"case":3,notat:1,retriev:[],look:1,provid:[3,1],intal:2,seealso:3,properti:1,onc:1,structur:1,cat:1,project:[3,1],matter:3,below:3,limit:3,whatev:1,doc:[1,2],posit:3,more:3,similar:3,favourit:[1,2],have:[3,1,2],certain:1,dure:3,argument:[],ugli:1,strongli:1,packag:2,exist:[],file:[3,1],lightweight:1,pip:2,dedic:1,check:1,again:[3,1],end:3,want:3,thing:3,perform:1,anoth:3,make:1,format:1,when:[3,1],detail:[],same:3,date_based_filt:3,write:[3,1],how:2,need:1,html:2,take:3,varieti:1,test:3,instead:1,you:[3,1,2],document:1,simpl:1,complet:1,week:3,finish:[3,1],http:[3,1,2],imagin:3,track:0,stop:3,after:3,chart:3,most:[3,1],date:[],data:1,aka:1,ago:3,task:[3,1],don:3,read:1,svg:3,descript:[3,1],spent:1,object:1,without:3,inform:1,exampl:[3,1],thi:[0,1,3],time:1,programm:1,decemb:1,sum:3},objtypes:{},objnames:{},filenames:["index","about","install","using"],titles:["Welcome to Stamper’s documentation!","About Stamper","Installation instructions","How to use it"],objects:{},titleterms:{timelin:3,argument:3,indic:0,instruct:2,stamper:[0,1],exist:3,tabl:0,instal:2,total:3,from:[3,1],welcom:0,record:3,stamp:3,detail:3,per:3,content:[3,1],how:3,json:1,consecut:3,document:0,full:3,tool:1,time:3,dai:3,base:3,date:3,come:1,about:1,retriev:3,list:3,doe:1,filter:3,inform:3,enter:1,where:1}})
+Search.setIndex({envversion:42,terms:{all:3,code:1,identifi:[3,1],forget:1,just:[3,2],show:3,text:[3,1],offici:0,verbos:3,becaus:1,interchang:1,human:1,follow:3,still:1,import_fil:3,languag:1,help:3,onli:3,slow:1,group:3,cli:3,easi:[1,2],how:2,graph:3,welter:1,ideal:1,littl:1,tail:1,program:1,dict:1,queri:1,save:[3,1],custom:[3,1],them:3,independ:1,"return":3,string:3,get:[3,1],python:[0,1,2],familiar:1,pypi:2,dai:1,obtain:1,repo:3,know:2,instead:1,report:1,bar:3,bit:1,month:3,sascha:1,betabug:[3,1],magic:1,like:1,did:[3,1],list:1,html:2,easili:1,exampl:[3,1],statist:1,each:3,januari:3,difficult:1,page:0,mean:1,subset:1,properti:1,timelin:[],some:[3,1,2],idea:1,born:1,cost:1,"export":1,result:3,year:3,extract:1,even:1,index:0,what:[3,1],insensit:3,implement:3,"3rd":1,space:3,miss:3,someth:1,below:3,per:1,your:[3,1,2],current:3,delet:3,written:[0,1],between:3,"import":[3,1],experi:2,ref:3,whatev:1,machin:1,afterward:1,full:[],august:3,situat:3,gener:[3,1],javascript:1,usag:3,here:1,standard:[1,2],base:1,nice:3,org:[1,2],sinc:3,search:0,last:3,wai:3,most:[3,1],keep:3,filter:[],etc:2,amount:1,tutori:2,fals:3,mani:1,chang:3,ecma:1,first:3,origin:1,yyyi:3,rang:3,simpli:3,ago:3,render:3,point:3,appli:3,modul:[0,2],inspir:1,easy_instal:2,yourself:3,instruct:[],alreadi:[3,2],famili:1,instal:[],next:3,open:1,workstamp:3,quit:[1,2],given:3,java:1,convent:1,stamp:1,perl:1,avail:2,start:[3,1],call:3,editor:1,handl:3,txt:1,conveni:1,store:3,includ:[3,1],project:[3,1],head:1,option:3,name:3,juli:3,edit:1,argument:[],pars:1,too:3,line:[3,1],those:[3,1],"case":3,notat:1,retriev:[],look:1,provid:[3,1],intal:2,seealso:3,work:[3,1],onc:1,structur:1,cat:1,bebu:3,matter:3,calcul:1,doc:[1,2],limit:3,can:[3,1],learn:3,posit:3,more:3,similar:3,favourit:[1,2],file:[3,1],creat:3,certain:1,dure:3,ani:3,ugli:1,strongli:1,packag:2,exist:[],have:[3,1,2],lightweight:1,pip:2,dedic:1,check:1,again:[3,1],end:3,want:3,thing:3,perform:1,anoth:3,make:1,format:[3,1],when:[3,1],detail:[],same:3,date_based_filt:3,write:[3,1],also:3,need:1,other:[3,1],take:3,varieti:1,test:3,record:1,you:[3,1,2],document:1,simpl:1,complet:1,week:3,finish:[3,1],http:[3,1,2],imagin:3,track:0,stop:3,symbol:3,after:3,chart:[],befor:3,programm:1,date:[],data:1,aka:1,tradit:1,task:[3,1],don:3,read:1,entri:1,descript:[3,1],svg:3,object:1,inform:1,without:3,command:3,thi:[0,1,3],time:1,far:3,link:3,decemb:1,spent:1,sum:3,latest:3},objtypes:{},objnames:{},filenames:["index","about","install","using"],titles:["Welcome to Stamper’s documentation!","About Stamper","Installation instructions","How to use it"],objects:{},titleterms:{timelin:3,argument:3,indic:0,instruct:2,stamper:[0,1],exist:3,tabl:0,instal:2,total:3,from:[3,1],welcom:0,inform:3,stamp:3,detail:3,per:3,content:[3,1],how:3,json:1,consecut:3,document:0,full:3,tool:1,enter:1,dai:3,chart:3,base:3,date:3,come:1,about:1,retriev:3,list:3,doe:1,filter:3,record:3,time:3,where:1}})

docs/_build/html/using.html

@@ -61 +61 @@
 <li><a class="reference internal" href="#per-day-details" id="id9">Per day details</a></li>
 <li><a class="reference internal" href="#timeline" id="id10">Timeline</a></li>
-<li><a class="reference internal" href="#full-list-of-arguments" id="id11">Full List of arguments</a></li>
-</ul>
-</li>
-<li><a class="reference internal" href="#date-based-filtering" id="id12">Date-based filtering</a></li>
+<li><a class="reference internal" href="#charts" id="id11">Charts</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#stamps-full-list-of-arguments" id="id12">stamps - full List of arguments</a></li>
+<li><a class="reference internal" href="#date-based-filtering" id="id13">Date-based filtering</a></li>
 </ul>
 </li>
@@ -200 +201 @@
 </div>
 </div>
-<div class="section" id="full-list-of-arguments">
-<h3><a class="toc-backref" href="#id11">Full List of arguments</a><a class="headerlink" href="#full-list-of-arguments" title="Permalink to this headline">¶</a></h3>
+<div class="section" id="charts">
+<h3><a class="toc-backref" href="#id11">Charts</a><a class="headerlink" href="#charts" title="Permalink to this headline">¶</a></h3>
+<p>You can generate some nice charts from your stamps. So far only bar charts
+showing the total time per day can be generated, but you can filter them by
+<strong>ID</strong> and/or date. Some examples:</p>
+<ul>
+<li><p class="first">Render a chart of all the times already stamped, by <strong>ID</strong>:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">stamps</span> <span class="o">-</span><span class="n">g</span>
+</pre></div>
+</div>
+</li>
+<li><p class="first">Render a chart of the stamps for the last 4 days:</p>
+<div class="highlight-python"><div class="highlight"><pre>stamps -g 4d
+</pre></div>
+</div>
+</li>
+<li><p class="first">Render a chart of the stamps for the <strong>ID</strong> <em>stamper</em> for the last week:</p>
+<div class="highlight-python"><div class="highlight"><pre>stamps -g stamper 1w
+</pre></div>
+</div>
+</li>
+</ul>
+<div class="admonition note">
+<p class="first admonition-title">Note</p>
+<p class="last">The charts will be saved into <strong>~/.workstamps-charts</strong>, in <a class="reference external" href="http://en.wikipedia.org/wiki/Scalable_Vector_Graphics">SVG</a> format.
+The name of the chart will be generated based on the current date and
+time, and a <em>symbolic link</em> called <strong>chart-latest.svg</strong> will be created,
+pointing to the latest chart generated.</p>
+</div>
+</div>
+</div>
+<div class="section" id="stamps-full-list-of-arguments">
+<h2><a class="toc-backref" href="#id12">stamps - full List of arguments</a><a class="headerlink" href="#stamps-full-list-of-arguments" title="Permalink to this headline">¶</a></h2>
+<p>You can get the full list of arguments from the command line too:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">stamps</span> <span class="o">-</span><span class="n">h</span>
+</pre></div>
+</div>
+<p>or:</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="n">stamps</span> <span class="o">--</span><span class="n">help</span>
+</pre></div>
+</div>
 <p>stamps: show recorded times information</p>
 <pre class="literal-block">
@@ -254 +294 @@
 </dl>
 </div>
-</div>
 <div class="section" id="date-based-filtering">
-<span id="id2"></span><h2><a class="toc-backref" href="#id12">Date-based filtering</a><a class="headerlink" href="#date-based-filtering" title="Permalink to this headline">¶</a></h2>
+<span id="id2"></span><h2><a class="toc-backref" href="#id13">Date-based filtering</a><a class="headerlink" href="#date-based-filtering" title="Permalink to this headline">¶</a></h2>
 <p>Most of the results returned by the <em>stamps</em> tool can be filtered using the
 following date-based filters:</p>
@@ -328 +367 @@
 <li><a class="reference internal" href="#per-day-details">Per day details</a></li>
 <li><a class="reference internal" href="#timeline">Timeline</a></li>
-<li><a class="reference internal" href="#full-list-of-arguments">Full List of arguments</a></li>
-</ul>
-</li>
+<li><a class="reference internal" href="#charts">Charts</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#stamps-full-list-of-arguments">stamps - full List of arguments</a></li>
 <li><a class="reference internal" href="#date-based-filtering">Date-based filtering</a></li>
 </ul>

docs/using.rst

@@ -131 +131 @@
 
 
-
-
-Full List of arguments
-++++++++++++++++++++++
+Charts
+++++++
+
+You can generate some nice charts from your stamps. So far only bar charts
+showing the total time per day can be generated, but you can filter them by
+**ID** and/or date. Some examples:
+
+- Render a chart of all the times already stamped, by **ID**::
+
+    stamps -g
+
+- Render a chart of the stamps for the last 4 days::
+
+    stamps -g 4d
+
+- Render a chart of the stamps for the **ID** *stamper* for the last week::
+
+    stamps -g stamper 1w
+
+.. note::
+
+   The charts will be saved into **~/.workstamps-charts**, in SVG_ format.
+   The name of the chart will be generated based on the current date and
+   time, and a *symbolic link* called **chart-latest.svg** will be created,
+   pointing to the latest chart generated.
+
+
+stamps - full List of arguments
+-------------------------------
+
+You can get the full list of arguments from the command line too::
+
+  stamps -h
+
+or::
+
+  stamps --help
 
 .. argparse::
@@ -188 +221 @@
 
 
+.. _SVG: http://en.wikipedia.org/wiki/Scalable_Vector_Graphics
+
 .. [1] http://repos.betabug.ch/stamp