Commits

ben...@localhost.nymphormation.net  committed 5a500e5

fix doc & regen

  • Participants
  • Parent commits 80e0f4a
  • Tags v0.1.6

Comments (0)

Files changed (12)

File docs/_build/doctrees/environment.pickle

Binary file modified.

File docs/_build/doctrees/resource.doctree

Binary file modified.

File docs/_build/doctrees/transports.doctree

Binary file modified.

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

 
 This module provide a common interface for all HTTP requests. This
 module make HTTP requests using `Pycurl`_ by default if installed or
-`Urllib2`_ if not. You could also use `Httplib2`_.
+`Httplib2`_.
 
 Example: 
 

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

 --------
 .. autoclass:: restclient.transport.HTTPTransportBase
 
+    .. automethod:: restclient.transport.HTTPTransportBase.__init__
     .. automethod:: restclient.transport.HTTPTransportBase.request
+    .. automethod:: restclient.transport.HTTPTransportBase.add_credentials
 
 
 .. autoclass:: restclient.transport.CurlTransport
 
 .. autoclass:: restclient.transport.HTTPLib2Transport
 
+    .. automethod:: restclient.transport.HTTPLib2Transport.__init__
+    .. automethod:: restclient.transport.HTTPLib2Transport.add_credentials
+

File docs/_build/html/genindex.html

 <dl>
 
 <dt><a href="resource.html#restclient.rest.Resource.__call__">__call__() (restclient.rest.Resource method)</a></dt>
-<dt><a href="transports.html#restclient.transport.CurlTransport.__init__">__init__() (restclient.transport.CurlTransport method)</a></dt></dl></td><td width="33%" valign="top"><dl>
+<dt><a href="transports.html#restclient.transport.CurlTransport.__init__">__init__() (restclient.transport.CurlTransport method)</a></dt>
+  <dd><dl>
+    <dt><a href="transports.html#restclient.transport.HTTPLib2Transport.__init__">(restclient.transport.HTTPLib2Transport method)</a></dt>
+    <dt><a href="transports.html#restclient.transport.HTTPTransportBase.__init__">(restclient.transport.HTTPTransportBase method)</a></dt>
+  </dl></dd></dl></td><td width="33%" valign="top"><dl>
 </dl></td></tr></table>
 
 <h2 id="A">A</h2>
 <table width="100%" class="indextable"><tr><td width="33%" valign="top">
 <dl>
 
-<dt><a href="transports.html#restclient.transport.CurlTransport.add_credentials">add_credentials() (restclient.transport.CurlTransport method)</a></dt></dl></td><td width="33%" valign="top"><dl>
+<dt><a href="transports.html#restclient.transport.CurlTransport.add_credentials">add_credentials() (restclient.transport.CurlTransport method)</a></dt>
+  <dd><dl>
+    <dt><a href="transports.html#restclient.transport.HTTPLib2Transport.add_credentials">(restclient.transport.HTTPLib2Transport method)</a></dt>
+    <dt><a href="transports.html#restclient.transport.HTTPTransportBase.add_credentials">(restclient.transport.HTTPTransportBase method)</a></dt>
+  </dl></dd></dl></td><td width="33%" valign="top"><dl>
 </dl></td></tr></table>
 
 <h2 id="C">C</h2>

File docs/_build/html/objects.inv

 restclient.rest.Resource.clone method resource.html
 restclient.Resource.transport attribute resource.html
 restclient.rest.RestClient.post method resource.html
-restclient.transport.CurlTransport.__init__ method transports.html
+restclient.rest.RestClient class resource.html
+restclient.transport.HTTPTransportBase.add_credentials method transports.html
 restclient.rest.RestClient.delete method resource.html
+restclient.transport.HTTPLib2Transport.__init__ method transports.html
 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.transport.CurlTransport class transports.html
 restclient.Resource.uri attribute resource.html
 restclient.rest.RequestError exception resource.html
-restclient.rest.RestClient class resource.html
+restclient.transport.CurlTransport.__init__ method transports.html
 restclient.rest.RestClient.head method resource.html
+restclient.transport.HTTPLib2Transport.add_credentials method transports.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
+restclient.transport.HTTPTransportBase.__init__ method transports.html

File docs/_build/html/resource.html

 <span id="resource-ref"></span><h1>Resource<a class="headerlink" href="#module-restclient" title="Permalink to this headline">¶</a></h1>
 <p>This module provide a common interface for all HTTP requests. This
 module make HTTP requests using <a class="reference external" href="http://pycurl.sourceforge.net/">Pycurl</a> by default if installed or
-<a href="#id5"><span class="problematic" id="id6">`Urllib2`_</span></a> if not. You could also use <a class="reference external" href="http://code.google.com/p/httplib2/">Httplib2</a>.</p>
+<a class="reference external" href="http://code.google.com/p/httplib2/">Httplib2</a>.</p>
 <p>Example:</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">restclient</span> <span class="kn">import</span> <span class="n">Resource</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">res</span> <span class="o">=</span> <span class="n">Resource</span><span class="p">(</span><span class="s">&#39;http://friendpaste.com&#39;</span><span class="p">)</span>

File docs/_build/html/searchindex.js

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

File docs/_build/html/transports.html

 <h2>Clients:<a class="headerlink" href="#clients" title="Permalink to this headline">¶</a></h2>
 <dl class="class">
 <dt id="restclient.transport.HTTPTransportBase">
-<!--[restclient.transport.HTTPTransportBase]-->class <tt class="descclassname">restclient.transport.</tt><tt class="descname">HTTPTransportBase</tt><a class="headerlink" href="#restclient.transport.HTTPTransportBase" title="Permalink to this definition">¶</a></dt>
+<!--[restclient.transport.HTTPTransportBase]-->class <tt class="descclassname">restclient.transport.</tt><tt class="descname">HTTPTransportBase</tt><big>(</big><em>proxy_infos=None</em><big>)</big><a class="headerlink" href="#restclient.transport.HTTPTransportBase" title="Permalink to this definition">¶</a></dt>
 <dd><p>Interface for HTTP clients</p>
 <dl class="method">
+<dt id="restclient.transport.HTTPTransportBase.__init__">
+<!--[restclient.transport.HTTPTransportBase.__init__]--><tt class="descname">__init__</tt><big>(</big><em>proxy_infos=None</em><big>)</big><a class="headerlink" href="#restclient.transport.HTTPTransportBase.__init__" title="Permalink to this definition">¶</a></dt>
+<dd><p>constructor for HTTP transport interface</p>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>proxy_infos</em> &#8211; dict, infos to connect via proxy:</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s">&#39;proxy_user&#39;</span><span class="p">:</span> <span class="s">&#39;XXXXXXX&#39;</span><span class="p">,</span>
+    <span class="s">&#39;proxy_password&#39;</span><span class="p">:</span> <span class="s">&#39;XXXXXXX&#39;</span><span class="p">,</span>
+    <span class="s">&#39;proxy_host&#39;</span><span class="p">:</span> <span class="s">&#39;proxy&#39;</span><span class="p">,</span>
+    <span class="s">&#39;proxy_port&#39;</span><span class="p">:</span> <span class="mf">8080</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+</dd></dl>
+
+<dl class="method">
 <dt id="restclient.transport.HTTPTransportBase.request">
 <!--[restclient.transport.HTTPTransportBase.request]--><tt class="descname">request</tt><big>(</big><em>url</em>, <em>method='GET'</em>, <em>body=None</em>, <em>headers=None</em><big>)</big><a class="headerlink" href="#restclient.transport.HTTPTransportBase.request" title="Permalink to this definition">¶</a></dt>
 <dd><p>Perform HTTP call and manage , support GET, HEAD, POST, PUT and
 </table>
 </dd></dl>
 
+<dl class="method">
+<dt id="restclient.transport.HTTPTransportBase.add_credentials">
+<!--[restclient.transport.HTTPTransportBase.add_credentials]--><tt class="descname">add_credentials</tt><big>(</big><em>user</em>, <em>password</em><big>)</big><a class="headerlink" href="#restclient.transport.HTTPTransportBase.add_credentials" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 </dd></dl>
 
 <dl class="class">
 <tbody valign="top">
 <tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
 <li><em>timeout</em> &#8211; int, timeout of request</li>
-<li><em>proxy_infos</em> &#8211; <p>dict, infos to connect via proxy:</p>
-<dl class="docutils">
-<dt>{</dt>
-<dd>&#8216;proxy_user&#8217;: &#8216;XXXXXXX&#8217;,
-&#8216;proxy_password&#8217;: &#8216;XXXXXXX&#8217;,
-&#8216;proxy_host&#8217;: &#8216;proxy&#8217;,
-&#8216;proxy_port&#8217;: 8080,</dd>
-</dl>
-<p>}</p>
-</li>
+<li><em>proxy_infos</em> &#8211; dict, infos to connect via proxy:</li>
 </ul>
 </td>
 </tr>
 </tbody>
 </table>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s">&#39;proxy_user&#39;</span><span class="p">:</span> <span class="s">&#39;XXXXXXX&#39;</span><span class="p">,</span>
+    <span class="s">&#39;proxy_password&#39;</span><span class="p">:</span> <span class="s">&#39;XXXXXXX&#39;</span><span class="p">,</span>
+    <span class="s">&#39;proxy_host&#39;</span><span class="p">:</span> <span class="s">&#39;proxy&#39;</span><span class="p">,</span>
+    <span class="s">&#39;proxy_port&#39;</span><span class="p">:</span> <span class="mf">8080</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
 </dd></dl>
 
 <dl class="method">
 
 <dl class="class">
 <dt id="restclient.transport.HTTPLib2Transport">
-<!--[restclient.transport.HTTPLib2Transport]-->class <tt class="descclassname">restclient.transport.</tt><tt class="descname">HTTPLib2Transport</tt><big>(</big><em>http=None</em><big>)</big><a class="headerlink" href="#restclient.transport.HTTPLib2Transport" title="Permalink to this definition">¶</a></dt>
+<!--[restclient.transport.HTTPLib2Transport]-->class <tt class="descclassname">restclient.transport.</tt><tt class="descname">HTTPLib2Transport</tt><big>(</big><em>proxy_infos=None</em>, <em>http=None</em><big>)</big><a class="headerlink" href="#restclient.transport.HTTPLib2Transport" title="Permalink to this definition">¶</a></dt>
 <dd><p>An http client that uses httplib2 for performing HTTP
 requests. This implementation supports HTTP caching.</p>
 <div class="admonition-see-also admonition seealso">
 <p class="first admonition-title">See also</p>
 <p class="last"><a class="reference external" href="http://code.google.com/p/httplib2/">Httplib2</a></p>
 </div>
+<dl class="method">
+<dt id="restclient.transport.HTTPLib2Transport.__init__">
+<!--[restclient.transport.HTTPLib2Transport.__init__]--><tt class="descname">__init__</tt><big>(</big><em>proxy_infos=None</em>, <em>http=None</em><big>)</big><a class="headerlink" href="#restclient.transport.HTTPLib2Transport.__init__" title="Permalink to this definition">¶</a></dt>
+<dd><table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>proxy_infos</em> &#8211; dict, infos to connect via proxy:</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+<div class="highlight-python"><div class="highlight"><pre><span class="p">{</span>
+    <span class="s">&#39;proxy_user&#39;</span><span class="p">:</span> <span class="s">&#39;XXXXXXX&#39;</span><span class="p">,</span>
+    <span class="s">&#39;proxy_password&#39;</span><span class="p">:</span> <span class="s">&#39;XXXXXXX&#39;</span><span class="p">,</span>
+    <span class="s">&#39;proxy_host&#39;</span><span class="p">:</span> <span class="s">&#39;proxy&#39;</span><span class="p">,</span>
+    <span class="s">&#39;proxy_port&#39;</span><span class="p">:</span> <span class="mf">8080</span><span class="p">,</span>
+<span class="p">}</span>
+</pre></div>
+</div>
+<table class="docutils field-list" frame="void" rules="none">
+<col class="field-name" />
+<col class="field-body" />
+<tbody valign="top">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<li><em>http</em> &#8211; An httplib2.HTTP instance.</li>
+</ul>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
+<dl class="method">
+<dt id="restclient.transport.HTTPLib2Transport.add_credentials">
+<!--[restclient.transport.HTTPLib2Transport.add_credentials]--><tt class="descname">add_credentials</tt><big>(</big><em>user</em>, <em>password</em><big>)</big><a class="headerlink" href="#restclient.transport.HTTPLib2Transport.add_credentials" title="Permalink to this definition">¶</a></dt>
+<dd></dd></dl>
+
 </dd></dl>
 
 </div>

File docs/resource.txt

 
 This module provide a common interface for all HTTP requests. This
 module make HTTP requests using `Pycurl`_ by default if installed or
-`Urllib2`_ if not. You could also use `Httplib2`_.
+`Httplib2`_.
 
 Example: 
 

File restclient/transport.py

 
         :param proxy_infos: dict, infos to connect via proxy:
 
+        .. code-block:: python
+
             {
                 'proxy_user': 'XXXXXXX',
                 'proxy_password': 'XXXXXXX',
         :param timeout: int, timeout of request
         :param proxy_infos: dict, infos to connect via proxy:
 
+        .. code-block:: python
+
             {
                 'proxy_user': 'XXXXXXX',
                 'proxy_password': 'XXXXXXX',
         """
         :param proxy_infos: dict, infos to connect via proxy:
 
+        .. code-block:: python
+    
             {
                 'proxy_user': 'XXXXXXX',
                 'proxy_password': 'XXXXXXX',