Commits

Anonymous committed e1d6ac8

regen doc

  • Participants
  • Parent commits 22b8be1

Comments (0)

Files changed (12)

File docs/_build/doctrees/console.doctree

Binary file added.

File docs/_build/doctrees/environment.pickle

Binary file modified.

File docs/_build/doctrees/index.doctree

Binary file modified.

File docs/_build/doctrees/transports.doctree

Binary file modified.

File docs/_build/html/_sources/console.txt

+.. _console:
+
+Console client
+==============
+
+A console client is available with py-restclient. It allow you to perform any HTTP
+ request you need in console.
+
+Examples :
+----------
+create a paste in Friedpaste from command line:
+
+.. code-block:: bash
+
+    benoitc@pollen:/tmp$ restcli -H "Accept:application/json" -H "Content-Type: application/json" -o result.json http://friendpaste.com POST - < test.json 
+    {"url": "http://friendpaste.com/1Po5tOC012QeFYOS3b3RaA", "rev": "373163383163", "ok": true, "id": "1Po5tOC012QeFYOS3b3RaA"}
+
+This command send tes.json file to Friendpaste and you get back the full url of paste in json result.
+
+test.json file :
+
+.. code-block:: javascript
+
+    {
+        "title":"I like to paste stuff",
+        "snippet":"My own paste",
+        "language":"text"
+    }
+
+
+Get your twitter status time line :
+
+.. code-block:: bash
+
+    benoitc@pollen:/tmp$ restcli http://XXXXXXX:XXXXXXX@twitter.com/statuses/user_timeline.json
+
+
+Usage :
+-------
+
+Options:
+  --version             show program's version number and exit
+  -h, --help            show this help message and exit
+  -H HEADERS, --header=HEADERS
+                        http string header in the form of Key:Value. For
+                        example: "Accept: application/json"
+  -i FILE, --input=FILE
+                        the name of the file to read from
+  -o OUTPUT, --output=OUTPUT
+                        the name of the file to read from
+  --proxy=PROXY         Full uri of proxy, ex:
+                        http://username:password@proxy:port/
+
+

File docs/_build/html/_sources/index.txt

    
    installation
    gettingstarted
+   console
    whatsnew
 
 .. _api:

File docs/_build/html/console.html

+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+    
+    <title>Console client &mdash; py-restclient v1.1 documentation</title>
+    <link rel="stylesheet" href="_static/default.css" type="text/css" />
+    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
+    <script type="text/javascript">
+      var DOCUMENTATION_OPTIONS = {
+        URL_ROOT:    '',
+        VERSION:     '1.1',
+        COLLAPSE_MODINDEX: false,
+        FILE_SUFFIX: '.html',
+        HAS_SOURCE:  true
+      };
+    </script>
+    <script type="text/javascript" src="_static/jquery.js"></script>
+    <script type="text/javascript" src="_static/doctools.js"></script>
+    <link rel="index" title="Index" href="genindex.html" />
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="top" title="py-restclient v1.1 documentation" href="index.html" />
+    <link rel="next" title="What&#8217;s New in python-restclient 1.1" href="whatsnew.html" />
+    <link rel="prev" title="Getting Started" href="gettingstarted.html" /> 
+  </head>
+  <body>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="modindex.html" title="Global Module Index"
+             accesskey="M">modules</a> |</li>
+        <li class="right" >
+          <a href="whatsnew.html" title="What&#8217;s New in python-restclient 1.1"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="gettingstarted.html" title="Getting Started"
+             accesskey="P">previous</a> |</li>
+        <li><a href="index.html">py-restclient v1.1 documentation</a> &raquo;</li> 
+      </ul>
+    </div>  
+    <div class="document">
+      <div class="documentwrapper">
+        <div class="bodywrapper">
+          <div class="body">
+            
+  
+  <div class="section" id="console-client">
+<span id="console"></span><h1>Console client<a class="headerlink" href="#console-client" title="Permalink to this headline">¶</a></h1>
+<dl class="docutils">
+<dt>A console client is available with py-restclient. It allow you to perform any HTTP</dt>
+<dd>request you need in console.</dd>
+</dl>
+<div class="section" id="examples">
+<h2>Examples :<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h2>
+<p>create a paste in Friedpaste from command line:</p>
+<div class="highlight-bash"><div class="highlight"><pre>benoitc@pollen:/tmp<span class="nv">$ </span>restcli -H <span class="s2">&quot;Accept:application/json&quot;</span> -H <span class="s2">&quot;Content-Type: application/json&quot;</span> -o result.json http://friendpaste.com POST - &lt; <span class="nb">test</span>.json
+<span class="o">{</span><span class="s2">&quot;url&quot;</span>: <span class="s2">&quot;http://friendpaste.com/1Po5tOC012QeFYOS3b3RaA&quot;</span>, <span class="s2">&quot;rev&quot;</span>: <span class="s2">&quot;373163383163&quot;</span>, <span class="s2">&quot;ok&quot;</span>: <span class="nb">true</span>, <span class="s2">&quot;id&quot;</span>: <span class="s2">&quot;1Po5tOC012QeFYOS3b3RaA&quot;</span><span class="o">}</span>
+</pre></div>
+</div>
+<p>This command send tes.json file to Friendpaste and you get back the full url of paste in json result.</p>
+<p>test.json file :</p>
+<div class="highlight-javascript"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s2">&quot;title&quot;</span><span class="o">:</span><span class="s2">&quot;I like to paste stuff&quot;</span><span class="o">,</span>
+    <span class="s2">&quot;snippet&quot;</span><span class="o">:</span><span class="s2">&quot;My own paste&quot;</span><span class="o">,</span>
+    <span class="s2">&quot;language&quot;</span><span class="o">:</span><span class="s2">&quot;text&quot;</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<p>Get your twitter status time line :</p>
+<div class="highlight-bash"><div class="highlight"><pre>benoitc@pollen:/tmp<span class="nv">$ </span>restcli http://XXXXXXX:XXXXXXX@twitter.com/statuses/user_timeline.json
+</pre></div>
+</div>
+</div>
+<div class="section" id="usage">
+<h2>Usage :<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
+<dl class="docutils">
+<dt>Options:</dt>
+<dd><table class="first last docutils option-list" frame="void" rules="none">
+<col class="option" />
+<col class="description" />
+<tbody valign="top">
+<tr><td class="option-group">
+<kbd><span class="option">--version</span></kbd></td>
+<td>show program&#8217;s version number and exit</td></tr>
+<tr><td class="option-group">
+<kbd><span class="option">-h</span>, <span class="option">--help</span></kbd></td>
+<td>show this help message and exit</td></tr>
+<tr><td class="option-group" colspan="2">
+<kbd><span class="option">-H <var>HEADERS</var></span>, <span class="option">--header=<var>HEADERS</var></span></kbd></td>
+</tr>
+<tr><td>&nbsp;</td><td>http string header in the form of Key:Value. For
+example: &#8220;Accept: application/json&#8221;</td></tr>
+<tr><td class="option-group" colspan="2">
+<kbd><span class="option">-i <var>FILE</var></span>, <span class="option">--input=<var>FILE</var></span></kbd></td>
+</tr>
+<tr><td>&nbsp;</td><td>the name of the file to read from</td></tr>
+<tr><td class="option-group" colspan="2">
+<kbd><span class="option">-o <var>OUTPUT</var></span>, <span class="option">--output=<var>OUTPUT</var></span></kbd></td>
+</tr>
+<tr><td>&nbsp;</td><td>the name of the file to read from</td></tr>
+<tr><td class="option-group">
+<kbd><span class="option">--proxy=<var>PROXY</var></span></kbd></td>
+<td>Full uri of proxy, ex:
+<a class="reference external" href="http://username:password&#64;proxy:port/">http://username:password&#64;proxy:port/</a></td></tr>
+</tbody>
+</table>
+</dd>
+</dl>
+</div>
+</div>
+
+
+          </div>
+        </div>
+      </div>
+      <div class="sphinxsidebar">
+        <div class="sphinxsidebarwrapper">
+            <h3><a href="index.html">Table Of Contents</a></h3>
+            <ul>
+<li><a class="reference external" href="">Console client</a><ul>
+<li><a class="reference external" href="#examples">Examples :</a></li>
+<li><a class="reference external" href="#usage">Usage :</a></li>
+</ul>
+</li>
+</ul>
+
+            <h4>Previous topic</h4>
+            <p class="topless"><a href="gettingstarted.html" title="previous chapter">Getting Started</a></p>
+            <h4>Next topic</h4>
+            <p class="topless"><a href="whatsnew.html" title="next chapter">What&#8217;s New in python-restclient 1.1</a></p>
+            <h3>This Page</h3>
+            <ul class="this-page-menu">
+              <li><a href="_sources/console.txt">Show Source</a></li>
+            </ul>
+          <h3>Quick search</h3>
+            <form class="search" action="search.html" method="get">
+              <input type="text" name="q" size="18" /> <input type="submit" value="Go" />
+              <input type="hidden" name="check_keywords" value="yes" />
+              <input type="hidden" name="area" value="default" />
+            </form>
+        </div>
+      </div>
+      <div class="clearer"></div>
+    </div>
+    <div class="related">
+      <h3>Navigation</h3>
+      <ul>
+        <li class="right" style="margin-right: 10px">
+          <a href="genindex.html" title="General Index"
+             accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="modindex.html" title="Global Module Index"
+             accesskey="M">modules</a> |</li>
+        <li class="right" >
+          <a href="whatsnew.html" title="What&#8217;s New in python-restclient 1.1"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="gettingstarted.html" title="Getting Started"
+             accesskey="P">previous</a> |</li>
+        <li><a href="index.html">py-restclient v1.1 documentation</a> &raquo;</li> 
+      </ul>
+    </div>
+    <div class="footer">
+      &copy; Copyright 2008, 2009 Benoit Chesneau &lt;benoitc@e-engura.org&gt;.
+      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.5.1.
+    </div>
+  </body>
+</html>

File docs/_build/html/index.html

 </li>
 </ul>
 <ul>
+<li class="toctree-l1"><a class="reference external" href="console.html">Console client</a><ul>
+<li class="toctree-l2"><a class="reference external" href="console.html#examples">Examples :</a></li>
+<li class="toctree-l2"><a class="reference external" href="console.html#usage">Usage :</a></li>
+</ul>
+</li>
+</ul>
+<ul>
 <li class="toctree-l1"><a class="reference external" href="whatsnew.html">What&#8217;s New in python-restclient 1.1</a><ul>
 <li class="toctree-l2"><a class="reference external" href="whatsnew.html#transports-changes">Transports changes</a></li>
 <li class="toctree-l2"><a class="reference external" href="whatsnew.html#support-of-file-objects-as-body">Support of File objects as body</a></li>

File docs/_build/html/objects.inv

 restclient.transport.HTTPTransportBase class transports.html
 restclient.rest.Unauthorized exception resource.html
 restclient.transport.HTTPLib2Transport class transports.html
-restclient.rest.RequestFailed exception resource.html
+restclient.rest.Resource.update_uri method resource.html
 restclient.rest.ResourceNotFound exception resource.html
 restclient.rest.Resource.__call__ method resource.html
 restclient.rest.Resource.post method resource.html
 restclient.rest.RestClient class resource.html
 restclient.rest.RestClient.head method resource.html
 restclient.transport.HTTPTransportBase.request method transports.html
-restclient.rest.Resource.update_uri method resource.html
+restclient.rest.RequestFailed exception resource.html
 restclient.transport.getDefaultHTTPTransport function transports.html

File docs/_build/html/searchindex.js

-Search.setIndex({desctypes:{"0":"method","1":"function","2":"class","3":"attribute","4":"exception"},terms:{serv:1,all:[4,1],code:[0,1,4],object:[3,1,5,4],also:[2,1,5,4],text:1,over:1,remov:4,rest:[0,1,3],actuib:5,own:1,through:[0,3],urllib:5,file:[3,1,4],follow:3,mainli:0,yet:0,languag:1,httptransportbas:[5,1],xml:1,absolut:1,style:3,now:4,depend:1,expos:0,wed:3,except:[3,1],send:4,should:[3,5],add:1,version:2,dict:[5,1],tring:1,"__call__":1,pass:1,headput:3,resourcenotfound:1,applic:[0,1],sourc:[3,2],"return":[5,1],string:1,later:2,get:[5,0,1,2,3],python:[4,0,2,3],prefer:5,safe:[4,1],know:3,base:[4,1,5],"new":[3,1,4],report:3,httptransport:5,password:5,brows:3,url:[3,1,5,4],requir:[2,1,3],restclient:[0,1,2,3,4,5],like:[3,1],specif:5,anyth:1,benoitc:2,list:1,html:1,authent:1,server:1,"default":[4,1,5],"case":5,resr2:1,common:1,timeout:5,contain:3,found:1,manag:5,mean:1,"3xdqq8g83llzvwgcewdwru":1,pthon:2,set:[5,1],transportthat:5,some:5,httplib2transport:[5,1],proxy_password:5,past:[0,1],see:[4,1,5],been:[4,5],connect:5,toctre:3,fail:1,our:[3,2],patch:5,extract:1,librari:0,index:3,what:[3,4],simplecouchdb:2,charat:1,make_request:0,someth:5,multimedia:3,onli:1,subclass:1,payload:1,access:[5,1],delet:[3,1,5],tracker:3,adapt:3,setdefaulthttptransport:5,print:[0,1],"import":[0,1,5],recommand:5,requesterror:1,method:[5,1],refer:3,altern:2,full:1,proxi:[5,1],kei:[0,1,4],htpp:5,engura:2,exampl:[0,1,5],usag:[0,1],decid:[3,1,4],here:5,fisrt:3,bodi:[3,1,5,4],step:3,proxy_us:5,symlink:2,repositori:2,byth:3,releas:2,org:2,post:[3,1,5],don:[4,1],optionn:[5,1],proxy_port:5,about:[3,1],last:2,friendpast:[0,1],statu:1,could:[2,1,4],proxy_host:5,http:[0,1,2,3,4,5],success:1,respons:[5,1],page:[0,1,3],microframework:3,entir:1,isn:4,constructor:5,action:[3,1],chang:[3,1,4],"5roqe9xtz7lcclgzoqs4ip":[0,1],com:[0,1],oper:5,via:[2,1,5],additionn:1,instanti:1,pythonpath:2,modul:[0,1,3],inspir:3,encod:[3,1,4],easy_instal:2,put:[5,1],api:[0,1],pypast:1,path:[2,1],encode_kei:1,instal:[4,0,1,2,3],your:[2,1,3],mercuri:2,alternatli:2,from:[5,0,1,2],messag:1,anoth:4,support:[4,0,1,5,3],fast:5,avail:2,start:[0,3],json:[0,1],call:[4,0,1,5,3],includ:1,basic:[5,1],paramet:[5,1],master:3,httpclient:[5,1],"function":[3,5],head:[5,1],option:1,unexpect:1,"public":3,copi:2,setuptool:2,search:3,specifi:[3,1],direct:3,content:4,curltransport:5,least:3,indic:3,requestfail:1,cheeseshop:2,given:1,"true":1,than:1,info:5,notfound:1,none:[5,1],made:3,utf:1,pycurl:[4,1,5],instanc:[5,1],remot:1,setup:2,properti:1,dev:2,xxxxxxx:5,project:3,defin:1,can:[2,1,5,3],str:[5,1],error:1,site:2,dec:3,root:3,update_uri:1,enki:3,overrid:1,createhttptransport:5,malform:1,quickstart:3,creat:[3,5],"int":5,descript:[0,1],sudo:2,anywher:2,accept:[0,1],repres:[5,1],packag:2,befor:4,implement:5,getdefaulthttptransport:5,have:[0,5,4],tabl:3,need:[4,2,1,3],revis:1,featur:[0,3],curl:5,"__init__":5,rewrit:4,result:1,alwai:2,renam:4,develop:[3,2],welcom:[3,5],want:[0,1,5],author:1,perform:[0,1,5,3],titl:1,make:[2,1,3],charset:[4,1],header:[0,1,5],same:4,unauthor:1,snippet:1,sinatra:3,when:[4,1,5],other:1,read:[0,4],transport:[3,1,5,4],which:[5,1],subdirectori:2,test:[5,1],add_credenti:5,you:[0,1,2,3,4,5],document:[0,3],simpl:[3,1],tutorial:0,complet:3,simplifi:4,resourc:[4,0,1,5,3],proxy_info:5,though:5,utf8:[4,1],clone:[2,1],time:4,urllib2:[4,1,5],interfac:[5,1],most:2,attempt:1,rais:1,user:5,mai:1,authentif:[5,1],param:[5,1],data:1,"class":[3,1],recent:2,bitbucket:[3,2],charact:[4,1],sphinx:3,ani:[5,1],bug:3,resourceresult:[3,1],directori:2,doc:0,cach:5,camp:3,request:[0,1,5],uri:1,probabl:1,receiv:1,depth:0,client:[4,0,1,5,3],command:2,thi:[0,1,2,3,4,5],choos:5,everyth:3,parameterss:1,http_code:[0,1],provid:1,httplib2:[2,1,5,4]},titles:["Getting Started","Resource","Installation","Welcome to python-restclient&#8217;s documentation!","What&#8217;s New in python-restclient 1.1","HTTP Transports"],modules:{restclient:1,"restclient.transport":5},descrefs:{"restclient.RestClient":{transport:[1,3]},"restclient.transport.CurlTransport":{add_credentials:[5,0],"__init__":[5,0]},"restclient.Resource":{uri:[1,3],transport:[1,3]},"restclient.rest.Resource":{head:[1,0],get:[1,0],clone:[1,0],request:[1,0],"__call__":[1,0],put:[1,0],post:[1,0],update_uri:[1,0],"delete":[1,0]},"restclient.rest.RestClient":{head:[1,0],get:[1,0],request:[1,0],put:[1,0],post:[1,0],"delete":[1,0]},"restclient.transport.HTTPTransportBase":{request:[5,0]},"restclient.rest":{Resource:[1,2],RestClient:[1,2],Unauthorized:[1,4],ResourceResult:[1,2],ResourceNotFound:[1,4],RequestError:[1,4],RequestFailed:[1,4]},"restclient.transport":{createHTTPTransport:[5,1],setDefaultHTTPTransport:[5,1],HTTPLib2Transport:[5,2],getDefaultHTTPTransport:[5,1],CurlTransport:[5,2],HTTPTransportBase:[5,2]}},filenames:["gettingstarted","resource","installation","index","whatsnew","transports"]})
+Search.setIndex({desctypes:{"0":"method","1":"function","2":"class","3":"attribute","4":"exception"},terms:{all:[5,1],code:[0,1,5],friedpast:4,follow:3,make_request:0,decid:[3,1,5],depend:1,send:[5,4],program:4,sourc:[3,2],string:[1,4],httptransport:6,brows:3,list:1,direct:3,proxy_password:6,past:[1,0,4],pass:1,port:4,index:3,what:[3,5],pypast:1,access:[6,1],delet:[3,1,6],version:[2,4],"new":[3,1,5],requesterror:1,method:[6,1],full:[1,4],unauthor:1,here:6,bodi:[3,1,6,5],proxy_us:6,path:[1,2],valu:4,optionn:[6,1],search:3,later:2,user_timelin:4,action:[3,1],chang:[3,1,5],via:[1,2,6],modul:[0,1,3],prefer:6,put:[6,1],api:[0,1],encode_kei:1,instal:[1,0,5,2,3],from:[1,0,4,2,6],call:[5,0,1,6,3],type:4,accept:[1,0,4],cheeseshop:2,recommand:6,cach:6,none:[6,1],pycurl:[5,1,6],setup:2,dev:2,can:[1,3,2,6],dec:3,root:3,overrid:1,malform:1,quickstart:3,createhttptransport:6,sudo:2,indic:3,want:[0,1,6],alwai:2,anoth:5,charset:[5,1],snippet:[1,4],subdirectori:2,simpl:[3,1],tutorial:0,restcli:4,resourc:[5,0,1,6,3],proxy_info:6,clone:[1,2],befor:5,mai:1,authentif:[6,1],data:1,attempt:1,receiv:1,allow:4,help:4,over:1,through:[0,3],mainli:0,paramet:[6,1],style:3,"return":[6,1],python:[5,0,2,3],safe:[5,1],httplib2:[1,2,6,5],now:5,restclient:[0,1,2,3,4,5,6],benoitc:[2,4],authent:1,timeout:6,found:1,mean:1,pthon:2,connect:6,our:[3,2],extract:1,rev:4,content:[5,4],rewrit:5,adapt:3,print:[0,1],proxi:[1,4,6],given:1,base:[5,1,6],byth:3,releas:2,org:2,friendpast:[1,0,4],could:[1,2,5],success:1,isn:5,oper:6,headput:3,number:4,least:3,payload:1,alternatli:2,messag:[1,4],mercuri:2,master:3,curltransport:6,consol:[3,4],option:[1,4],"public":3,copi:2,setuptool:2,specifi:[3,1],than:1,serv:1,notfound:1,remot:1,remov:5,charact:[5,1],project:3,str:[6,1],update_uri:1,anywher:2,packag:2,have:[0,6,5],tabl:3,need:[1,2,5,4,3],unexpect:1,also:[1,2,6,5],client:[0,1,3,4,5,6],which:[6,1],command:[2,4],simplifi:5,though:6,usernam:4,setdefaulthttptransport:6,object:[3,1,6,5],most:2,"class":[3,1],don:[5,1],url:[1,3,4,6,5],doc:0,camp:3,request:[1,0,4,6],uri:[1,4],multimedia:3,show:4,text:[1,4],actuib:6,xml:1,absolut:1,onli:1,should:[3,6],dict:[6,1],"__call__":1,get:[0,1,2,3,4,6],report:3,requir:[1,3,2],patch:6,provid:1,stuff:4,common:1,contain:3,set:[6,1],transportthat:6,httplib2transport:[6,1],see:[5,1,6],result:[1,4],respons:[6,1],fail:1,statu:[1,4],simplecouchdb:2,charat:1,someth:6,urllib:6,"import":[0,1,6],altern:2,kei:[1,0,4,5],engura:2,fisrt:3,proxy_port:6,entir:1,last:2,proxy_host:6,instanc:[6,1],com:[1,0,4],instanti:1,inspir:3,header:[1,0,4,6],resr2:1,been:[5,6],json:[1,0,4],basic:[6,1],ani:[1,4,6],resourceresult:[3,1],requestfail:1,"case":6,properti:1,defin:1,error:1,site:2,getdefaulthttptransport:6,revis:1,"__init__":6,develop:[3,2],welcom:[3,6],author:1,perform:[1,0,4,6,3],make:[1,3,2],same:5,html:1,resourcenotfound:1,document:[0,3],complet:3,status:4,http:[0,1,2,3,4,5,6],utf8:[5,1],rais:1,user:6,implement:6,recent:2,exampl:[1,0,4,6,3],add_credenti:6,thi:[0,1,2,3,4,5,6],choos:6,everyth:3,http_code:[0,1],pollen:4,rest:[0,1,3],yet:0,languag:[1,4],httptransportbas:[6,1],"1po5toc012qefyos3b3raa":4,expos:0,wed:3,except:[3,1],param:[6,1],add:1,tring:1,input:4,applic:[1,0,4],read:[0,4,5],know:3,password:[6,4],name:4,like:[1,3,4],specif:6,anyth:1,server:1,output:4,page:[0,1,3],twitter:4,some:6,back:4,enki:3,toctre:3,transport:[3,1,6,5],tmp:4,subclass:1,tracker:3,exit:4,refer:3,"3xdqq8g83llzvwgcewdwru":1,htpp:6,usag:[1,0,4,3],symlink:2,step:3,repositori:2,post:[1,3,4,6],about:[3,1],manag:6,microframework:3,constructor:6,own:[1,4],additionn:1,pythonpath:2,encod:[3,1,5],easy_instal:2,your:[1,2,4,3],support:[5,0,1,6,3],fast:6,avail:[2,4],start:[0,3],interfac:[6,1],includ:1,httpclient:[6,1],"function":[3,6],head:[6,1],form:4,renam:5,line:4,"true":[1,4],bug:3,info:6,made:3,utf:1,"default":[5,1,6],xxxxxxx:[6,4],"5roqe9xtz7lcclgzoqs4ip":[0,1],featur:[0,3],creat:[3,4,6],"int":6,repres:[6,1],file:[1,3,4,5],curl:6,probabl:1,sinatra:3,titl:[1,4],when:[5,1,6],other:1,librari:0,test:[1,4,6],you:[0,1,2,3,4,5,6],urllib2:[5,1,6],bitbucket:[3,2],sphinx:3,directori:2,descript:[0,1],depth:0,time:[5,4],parameterss:1},titles:["Getting Started","Resource","Installation","Welcome to python-restclient&#8217;s documentation!","Console client","What&#8217;s New in python-restclient 1.1","HTTP Transports"],modules:{restclient:1,"restclient.transport":6},descrefs:{"restclient.RestClient":{transport:[1,3]},"restclient.transport.CurlTransport":{add_credentials:[6,0],"__init__":[6,0]},"restclient.Resource":{uri:[1,3],transport:[1,3]},"restclient.rest.Resource":{head:[1,0],get:[1,0],clone:[1,0],request:[1,0],"__call__":[1,0],put:[1,0],post:[1,0],update_uri:[1,0],"delete":[1,0]},"restclient.rest.RestClient":{head:[1,0],get:[1,0],request:[1,0],put:[1,0],post:[1,0],"delete":[1,0]},"restclient.transport.HTTPTransportBase":{request:[6,0]},"restclient.rest":{Resource:[1,2],RestClient:[1,2],Unauthorized:[1,4],ResourceResult:[1,2],ResourceNotFound:[1,4],RequestError:[1,4],RequestFailed:[1,4]},"restclient.transport":{createHTTPTransport:[6,1],setDefaultHTTPTransport:[6,1],HTTPLib2Transport:[6,2],getDefaultHTTPTransport:[6,1],CurlTransport:[6,2],HTTPTransportBase:[6,2]}},filenames:["gettingstarted","resource","installation","index","console","whatsnew","transports"]})

File docs/_build/html/transports.html

 
 <dl class="class">
 <dt id="restclient.transport.CurlTransport">
-<!--[restclient.transport.CurlTransport]-->class <tt class="descclassname">restclient.transport.</tt><tt class="descname">CurlTransport</tt><big>(</big><em>timeout=None</em>, <em>proxy_infos={}</em><big>)</big><a class="headerlink" href="#restclient.transport.CurlTransport" title="Permalink to this definition">¶</a></dt>
+<!--[restclient.transport.CurlTransport]-->class <tt class="descclassname">restclient.transport.</tt><tt class="descname">CurlTransport</tt><big>(</big><em>timeout=None</em>, <em>proxy_infos=None</em><big>)</big><a class="headerlink" href="#restclient.transport.CurlTransport" title="Permalink to this definition">¶</a></dt>
 <dd><p>An HTTP transportthat uses pycurl.</p>
 <p>Pycurl is recommanded when you want fast access to http resources.
 We have added some basic management of authentification and proxies,
 </div>
 <dl class="method">
 <dt id="restclient.transport.CurlTransport.__init__">
-<!--[restclient.transport.CurlTransport.__init__]--><tt class="descname">__init__</tt><big>(</big><em>timeout=None</em>, <em>proxy_infos={}</em><big>)</big><a class="headerlink" href="#restclient.transport.CurlTransport.__init__" title="Permalink to this definition">¶</a></dt>
+<!--[restclient.transport.CurlTransport.__init__]--><tt class="descname">__init__</tt><big>(</big><em>timeout=None</em>, <em>proxy_infos=None</em><big>)</big><a class="headerlink" href="#restclient.transport.CurlTransport.__init__" title="Permalink to this definition">¶</a></dt>
 <dd><p>Curl transport constructor</p>
 <table class="docutils field-list" frame="void" rules="none">
 <col class="field-name" />

File docs/console.txt

 ----------
 create a paste in Friedpaste from command line:
 
+.. code-block:: bash
+
     benoitc@pollen:/tmp$ restcli -H "Accept:application/json" -H "Content-Type: application/json" -o result.json http://friendpaste.com POST - < test.json 
-{"url": "http://friendpaste.com/1Po5tOC012QeFYOS3b3RaA", "rev": "373163383163", "ok": true, "id": "1Po5tOC012QeFYOS3b3RaA"}
+    {"url": "http://friendpaste.com/1Po5tOC012QeFYOS3b3RaA", "rev": "373163383163", "ok": true, "id": "1Po5tOC012QeFYOS3b3RaA"}
 
 This command send tes.json file to Friendpaste and you get back the full url of paste in json result.
 
-test.json:
+test.json file :
+
+.. code-block:: javascript
 
     {
         "title":"I like to paste stuff",
         "language":"text"
     }
 
+
 Get your twitter status time line :
 
-    restcli http://XXXXXXX:XXXXXXX@twitter.com/statuses/user_timeline.json
+.. code-block:: bash
+
+    benoitc@pollen:/tmp$ restcli http://XXXXXXX:XXXXXXX@twitter.com/statuses/user_timeline.json
 
 
 Usage :