540e755bced8
birdgrinder: Update documentation.
| author | Steve Losh <steve@stevelosh.com> |
|---|---|
| date | Sun, 25 Jul 2010 11:54:57 -0400 |
| parents | d8f0123253af |
| children | 08b2deff2e09 |
| branches/tags | (none) |
| files | birdgrinder/_sources/index.txt birdgrinder/_static/chunky.css birdgrinder/_static/chunky.less birdgrinder/index.html birdgrinder/searchindex.js |
Changes
--- a/birdgrinder/_sources/index.txt Sun Jul 25 02:28:38 2010 -0400 +++ b/birdgrinder/_sources/index.txt Sun Jul 25 11:54:57 2010 -0400 @@ -30,6 +30,14 @@ for tweet_json in unknown_tweets: print grinder.grind(tweet_json) + .. container:: get + + `Fork it on BitBucket ➙ <http://bitbucket.org/sjl/birdgrinder/>`_ + `Fork it on GitHub ➙ <http://github.com/sjl/birdgrinder/>`_ + + `Report a bug ➙ <http://bitbucket.org/sjl/birdgrinder/issues/>`_ + + .. container:: intro Trying to grab tweets about a `version control system @@ -43,6 +51,8 @@ Save and restore your personalized grinder to a variety of backends like flat files or `Redis <http://code.google.com/p/redis/>`_. + It's `MIT/X11 <http://en.wikipedia.org/wiki/MIT_License>`_ licensed. + .. contents:: :local: @@ -161,14 +171,22 @@ # Saves/restores to/from anothergrinder:* other_grinder = Grinder(storage='redis', key_prefix='anothergrinder') -If your Redis instance isn't running on localhost on the default port you can -change that as well:: +If your Redis instance isn't running on localhost on the default port with the +default database number you can change that as well:: from birdgrinder import Grinder - grinder = Grinder(storage='redis', host='192.168.0.16', port=7000) + grinder = Grinder(storage='redis', host='192.168.0.16', port=7000, db=2) Advanced Usage -------------- TODO: Later. + + +Contributing +------------ + +To contribute bug fixes, performance improvements or new features just fork the +`BitBucket repository <http://bitbucket.org/sjl/birdgrinder/>`_ or `GitHub +repository <http://github.com/sjl/birdgrinder/>`_ and send a pull request.
--- a/birdgrinder/_static/chunky.css Sun Jul 25 02:28:38 2010 -0400 +++ b/birdgrinder/_static/chunky.css Sun Jul 25 11:54:57 2010 -0400 @@ -74,6 +74,7 @@ body h6 a:hover, html h6 a:hover { border-bottom: none; + color: #5e5d00; } body h1, html h1 { font-size: 4.5em; @@ -113,6 +114,25 @@ width: 350px; float: right; margin-left: 20px; + margin-top: -12px; +} +body .quickstart .get a, html .quickstart .get a { + color: #111; + border-bottom: none; +} +body .quickstart .get a:hover, html .quickstart .get a:hover { + border-bottom: none; + color: #5e5d00; +} +body .quickstart .get a, html .quickstart .get a { + display: block; + text-align: right; + font-family: ChunkFiveRegular, serif; + font-size: 1.5em; + margin: 0 0 0.25em; +} +body .quickstart pre, html .quickstart pre { + margin-bottom: 37px; } body pre, html pre { font-size: 14px;
--- a/birdgrinder/_static/chunky.less Sun Jul 25 02:28:38 2010 -0400 +++ b/birdgrinder/_static/chunky.less Sun Jul 25 11:54:57 2010 -0400 @@ -12,6 +12,18 @@ font-style: normal; } +.link-plain() { + a { + color: #111; + border-bottom: none; + } + + a:hover { + border-bottom: none; + color: lighten(@c-dark-cream, 50%); + } +} + html { overflow-y: scroll; } @@ -43,14 +55,7 @@ font-family: ChunkFiveRegular; font-weight: normal; - a { - color: #111; - border-bottom: none; - - &:hover { - border-bottom: none; - } - } + .link-plain(); } h1 { font-size: 4.5em; @@ -93,6 +98,22 @@ width: @width / 2; float: right; margin-left: 20px; + margin-top: -12px; + + .get { + .link-plain(); + + a { + display: block; + text-align: right; + font-family: ChunkFiveRegular, serif; + font-size: 1.5em; + margin: 0 0 0.25em; + } + } + pre { + margin-bottom: 37px; + } } pre { font-size: 14px;
--- a/birdgrinder/index.html Sun Jul 25 02:28:38 2010 -0400 +++ b/birdgrinder/index.html Sun Jul 25 11:54:57 2010 -0400 @@ -63,6 +63,11 @@ <span class="k">print</span> <span class="n">grinder</span><span class="o">.</span><span class="n">grind</span><span class="p">(</span><span class="n">tweet_json</span><span class="p">)</span> </pre></div> </div> +<div class="get container"> +<p><a class="reference external" href="http://bitbucket.org/sjl/birdgrinder/">Fork it on BitBucket ➙</a> +<a class="reference external" href="http://github.com/sjl/birdgrinder/">Fork it on GitHub ➙</a></p> +<p><a class="reference external" href="http://bitbucket.org/sjl/birdgrinder/issues/">Report a bug ➙</a></p> +</div> </div> <div class="intro container"> <p>Trying to grab tweets about a <a class="reference external" href="http://hg-scm.org/">version control system</a> and getting tweets about <a class="reference external" href="http://en.wikipedia.org/wiki/Nike_Mercurial_Vapor">some kind of shoe</a> in the mix? Use the @@ -71,6 +76,7 @@ they pass the test.</p> <p>Save and restore your personalized grinder to a variety of backends like flat files or <a class="reference external" href="http://code.google.com/p/redis/">Redis</a>.</p> +<p>It’s <a class="reference external" href="http://en.wikipedia.org/wiki/MIT_License">MIT/X11</a> licensed.</p> </div> <div class="contents local topic" id="contents"> <ul class="simple"> @@ -82,6 +88,7 @@ </ul> </li> <li><a class="reference external" href="#advanced-usage" id="id8">Advanced Usage</a></li> +<li><a class="reference external" href="#contributing" id="id9">Contributing</a></li> </ul> </div> <div class="section" id="installation"> @@ -187,11 +194,11 @@ <span class="n">other_grinder</span> <span class="o">=</span> <span class="n">Grinder</span><span class="p">(</span><span class="n">storage</span><span class="o">=</span><span class="s">'redis'</span><span class="p">,</span> <span class="n">key_prefix</span><span class="o">=</span><span class="s">'anothergrinder'</span><span class="p">)</span> </pre></div> </div> -<p>If your Redis instance isn’t running on localhost on the default port you can -change that as well:</p> +<p>If your Redis instance isn’t running on localhost on the default port with the +default database number you can change that as well:</p> <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">birdgrinder</span> <span class="kn">import</span> <span class="n">Grinder</span> -<span class="n">grinder</span> <span class="o">=</span> <span class="n">Grinder</span><span class="p">(</span><span class="n">storage</span><span class="o">=</span><span class="s">'redis'</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="s">'192.168.0.16'</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">7000</span><span class="p">)</span> +<span class="n">grinder</span> <span class="o">=</span> <span class="n">Grinder</span><span class="p">(</span><span class="n">storage</span><span class="o">=</span><span class="s">'redis'</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="s">'192.168.0.16'</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="mi">7000</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="mi">2</span><span class="p">)</span> </pre></div> </div> </div> @@ -200,6 +207,12 @@ <h2><a class="toc-backref" href="#id8">Advanced Usage</a></h2> <p>TODO: Later.</p> </div> +<div class="section" id="contributing"> +<h2><a class="toc-backref" href="#id9">Contributing</a></h2> +<p>To contribute bug fixes, performance improvements or new features just fork the +<a class="reference external" href="http://bitbucket.org/sjl/birdgrinder/">BitBucket repository</a> or <a class="reference external" href="http://github.com/sjl/birdgrinder/">GitHub +repository</a> and send a pull request.</p> +</div> </div>
--- a/birdgrinder/searchindex.js Sun Jul 25 02:28:38 2010 -0400 +++ b/birdgrinder/searchindex.js Sun Jul 25 11:54:57 2010 -0400 @@ -1,1 +1,1 @@ -Search.setIndex({objects:{},terms:{elif:0,help:0,becaus:0,prefix:0,through:0,shoe:0,find:0,categori:0,onli:0,cut:0,system:0,mix:0,tweet:0,state:0,better:0,persist:[],mediocr:[],save:0,good:0,"return":0,thei:0,get:0,python:0,fat:0,"new":0,wipe:[],like:0,manual:0,method:0,"try":0,"default":0,bad:0,either:0,pipsadsadsa:[],grab:0,page:[],other_grind:0,twitter:0,some:0,satisfactori:0,result:0,pass:0,todo:0,port:0,librari:0,out:0,tmp:0,index:[],what:0,good_tweet:0,power:0,content:[],enough:0,version:0,leav:0,print:0,"import":0,meatiest:0,bird:0,localhost:0,run:0,kei:0,advanc:0,usag:0,free:0,small:0,host:0,org:0,"throw":0,birdgrind:0,about:0,last:0,howev:0,current:[],unsav:[],offtop:0,instanc:0,isn:0,sjl:0,awai:0,implement:0,com:0,frequent:0,user:0,simpli:[],feel:0,onc:0,modul:[],number:0,automat:0,two:0,filenam:0,alreadi:0,new_tweet:0,instal:0,redi:0,next:[],storag:0,your:0,backend:0,bad_tweet:0,git:0,from:0,spam:0,unknown:0,support:0,three:0,custom:0,mercuri:0,start:[],json:0,call:0,basic:0,new_grind:0,sharpen:0,store:0,more:[],sort:0,flat:0,option:0,form:0,search:[],specifi:0,argument:0,github:0,train:0,categor:0,kind:0,restor:0,provid:0,rate:0,can:0,expect:0,control:0,quickstart:[],creat:0,well:0,ani:[],indic:[],raw:0,inform:0,exist:[],file:0,tabl:[],pip:0,sharp:0,check:[],probabl:0,everywher:0,filter:0,grinder:0,welcom:[],want:0,person:0,perform:0,tweet_json:0,format:0,when:0,classifi:0,also:[],need:0,varieti:0,test:0,you:0,document:[],nice:0,anothergrind:0,http:0,thi:0,again:0,unknown_tweet:0,befor:0,openplan:[],initi:0,mai:0,data:0,chang:0,bitbucket:0,receiv:0,read:[],later:0,cover:[],grind:0,mark:0,exampl:[],unaccept:0,determin:0,time:[],egg:0,key_prefix:0,usual:0},objtypes:{},titles:["The Bird Grinder"],objnames:{},filenames:["index"]}) \ No newline at end of file +Search.setIndex({objects:{},terms:{elif:0,help:0,just:0,becaus:0,prefix:0,through:0,shoe:0,find:0,categori:0,onli:0,cut:0,system:0,mix:0,tweet:0,state:0,send:0,wipe:[],better:0,persist:[],mediocr:[],save:0,good:0,"return":0,contribut:0,thei:0,get:0,python:0,fat:0,"new":0,report:0,meatiest:0,well:0,like:0,manual:0,method:0,"try":0,"default":0,bad:0,either:0,pipsadsadsa:[],x11:0,grab:0,page:[],other_grind:0,twitter:0,some:0,satisfactori:0,result:0,pass:0,todo:0,port:0,librari:0,out:0,tmp:0,index:[],what:0,good_tweet:0,kei:0,databas:0,content:[],enough:0,version:0,leav:0,print:0,"import":0,awai:0,bird:0,localhost:0,run:0,power:0,advanc:0,usag:0,free:0,small:0,host:0,repositori:0,org:0,"throw":0,birdgrind:0,about:0,last:0,howev:0,current:[],unsav:[],offtop:0,instanc:0,isn:0,sjl:0,improv:0,chang:0,com:0,fix:0,frequent:0,user:0,simpli:[],feel:0,onc:0,modul:[],number:0,automat:0,two:0,filenam:0,alreadi:0,new_tweet:0,instal:0,redi:0,next:[],storag:0,your:0,backend:0,bad_tweet:0,git:0,from:0,spam:0,unknown:0,licens:0,support:0,three:0,custom:0,mercuri:0,start:[],json:0,call:0,basic:0,new_grind:0,sharpen:0,store:0,more:[],sort:0,flat:0,option:0,form:0,search:[],specifi:0,argument:0,github:0,train:0,categor:0,bug:0,pull:0,kind:0,restor:0,provid:0,rate:0,can:0,expect:0,control:0,fork:0,featur:0,quickstart:[],creat:0,cover:[],ani:[],indic:[],raw:0,inform:0,exist:[],file:0,tabl:[],pip:0,sharp:0,check:[],probabl:0,everywher:0,filter:0,grinder:0,welcom:[],want:0,person:0,perform:0,tweet_json:0,format:0,when:0,classifi:0,also:[],need:0,rarr:[],varieti:0,test:0,you:0,document:[],mit:0,nice:0,anothergrind:0,http:0,thi:0,again:0,unknown_tweet:0,befor:0,openplan:[],initi:0,mai:0,data:0,implement:0,bitbucket:0,receiv:0,read:[],later:0,request:0,grind:0,mark:0,exampl:[],unaccept:0,determin:0,time:[],egg:0,key_prefix:0,usual:0},objtypes:{},titles:["The Bird Grinder"],objnames:{},filenames:["index"]}) \ No newline at end of file