Commits

ben...@localhost.nymphormation.net  committed 197d7ed

fix doc & regen

  • Participants
  • Parent commits 3dac8a4

Comments (0)

Files changed (11)

File docs/_build/doctrees/environment.pickle

Binary file modified.

File docs/_build/doctrees/index.doctree

Binary file modified.

File docs/_build/doctrees/resource.doctree

Binary file modified.

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

 
 .. rubric:: Everything you need to know about python-restclient.
 
-**Python-restclient** is simple **REST client for Python**, inspired by the
-microframework (Camping, Sinatra) style of specifying actions: get, head
-put, post, delete.
+**Python-restclient** is simple **REST client for Python**, inspired bythe microframework (Camping, Sinatra) style of specifying actions: get,headput, post, delete. It started  in `Enki Multimedia <http://www.e-engura.org>`_ for one of our project and we decided to make it public.
 
 Fisrt steps
 ===========

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

 
     **Methods**
 
-    .. automethod:: restclient.rest.Resource.get
+    .. automethod:: restclient.rest.RestClient.get
 
-    .. automethod:: restclient.rest.Resource.head
+    .. automethod:: restclient.rest.RestClient.head
 
-    .. automethod:: restclient.rest.Resource.delete
+    .. automethod:: restclient.rest.RestClient.delete
 
-    .. automethod:: restclient.rest.Resource.post
+    .. automethod:: restclient.rest.RestClient.post
 
-    .. automethod:: restclient.rest.Resource.put
+    .. automethod:: restclient.rest.RestClient.put
 
-    .. automethod:: restclient.rest.Resource.make_request
+    .. automethod:: restclient.rest.RestClient.make_request
 
 
 Exceptions

File docs/_build/html/genindex.html

 
    <h1 id="index">Index</h1>
 
-   <a href="#_"><strong>_</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#U"><strong>U</strong></a> 
+   <a href="#_"><strong>_</strong></a> | <a href="#C"><strong>C</strong></a> | <a href="#D"><strong>D</strong></a> | <a href="#G"><strong>G</strong></a> | <a href="#H"><strong>H</strong></a> | <a href="#M"><strong>M</strong></a> | <a href="#P"><strong>P</strong></a> | <a href="#R"><strong>R</strong></a> | <a href="#S"><strong>S</strong></a> | <a href="#U"><strong>U</strong></a> 
 
    <hr />
 
 
 <dt><a href="resource.html#restclient.rest.Resource.delete">delete() (restclient.rest.Resource method)</a></dt>
   <dd><dl>
-    <dt><a href="resource.html#restclient.rest.RestClient.Resource.delete">(restclient.rest.RestClient.Resource method)</a></dt>
+    <dt><a href="resource.html#restclient.rest.RestClient.delete">(restclient.rest.RestClient method)</a></dt>
   </dl></dd></dl></td><td width="33%" valign="top"><dl>
 </dl></td></tr></table>
 
 
 <dt><a href="resource.html#restclient.rest.Resource.get">get() (restclient.rest.Resource method)</a></dt>
   <dd><dl>
-    <dt><a href="resource.html#restclient.rest.RestClient.Resource.get">(restclient.rest.RestClient.Resource method)</a></dt>
+    <dt><a href="resource.html#restclient.rest.RestClient.get">(restclient.rest.RestClient method)</a></dt>
   </dl></dd>
 <dt><a href="resource.html#restclient.rest.Resource.get_status_code">get_status_code() (restclient.rest.Resource method)</a></dt></dl></td><td width="33%" valign="top"><dl>
 <dt><a href="httpclient.html#restclient.http.getDefaultHTTPClient">getDefaultHTTPClient() (in module restclient.http)</a></dt>
 
 <dt><a href="resource.html#restclient.rest.Resource.head">head() (restclient.rest.Resource method)</a></dt>
   <dd><dl>
-    <dt><a href="resource.html#restclient.rest.RestClient.Resource.head">(restclient.rest.RestClient.Resource method)</a></dt>
+    <dt><a href="resource.html#restclient.rest.RestClient.head">(restclient.rest.RestClient method)</a></dt>
   </dl></dd>
 <dt><a href="httpclient.html#restclient.http.HTTPClient">HTTPClient (class in restclient.http)</a></dt>
 <dt><a href="resource.html#restclient.Resource.httpclient">httpclient (restclient.Resource attribute)</a></dt>
 <dt><a href="httpclient.html#restclient.http.HTTPLib2HTTPClient">HTTPLib2HTTPClient (class in restclient.http)</a></dt>
 </dl></td></tr></table>
 
+<h2 id="M">M</h2>
+<table width="100%" class="indextable"><tr><td width="33%" valign="top">
+<dl>
+
+<dt><a href="resource.html#restclient.rest.RestClient.make_request">make_request() (restclient.rest.RestClient method)</a></dt></dl></td><td width="33%" valign="top"><dl>
+</dl></td></tr></table>
+
 <h2 id="P">P</h2>
 <table width="100%" class="indextable"><tr><td width="33%" valign="top">
 <dl>
 
 <dt><a href="resource.html#restclient.rest.Resource.post">post() (restclient.rest.Resource method)</a></dt>
   <dd><dl>
-    <dt><a href="resource.html#restclient.rest.RestClient.Resource.post">(restclient.rest.RestClient.Resource method)</a></dt>
+    <dt><a href="resource.html#restclient.rest.RestClient.post">(restclient.rest.RestClient method)</a></dt>
   </dl></dd>
 <dt><a href="resource.html#restclient.rest.Resource.put">put() (restclient.rest.Resource method)</a></dt>
   <dd><dl>
-    <dt><a href="resource.html#restclient.rest.RestClient.Resource.put">(restclient.rest.RestClient.Resource method)</a></dt>
+    <dt><a href="resource.html#restclient.rest.RestClient.put">(restclient.rest.RestClient method)</a></dt>
   </dl></dd></dl></td><td width="33%" valign="top"><dl>
 </dl></td></tr></table>
 

File docs/_build/html/index.html

   <div class="section" id="welcome-to-python-restclient-s-documentation">
 <h1>Welcome to python-restclient&#8217;s documentation!<a class="headerlink" href="#welcome-to-python-restclient-s-documentation" title="Permalink to this headline">¶</a></h1>
 <p class="rubric">Everything you need to know about python-restclient.</p>
-<p><strong>Python-restclient</strong> is simple <strong>REST client for Python</strong>, inspired by the
-microframework (Camping, Sinatra) style of specifying actions: get, head
-put, post, delete.</p>
+<p><strong>Python-restclient</strong> is simple <strong>REST client for Python</strong>, inspired bythe microframework (Camping, Sinatra) style of specifying actions: get,headput, post, delete. It started  in <a class="reference" href="http://www.e-engura.org">Enki Multimedia</a> for one of our project and we decided to make it public.</p>
 </div>
 <div class="section" id="fisrt-steps">
 <h1>Fisrt steps<a class="headerlink" href="#fisrt-steps" title="Permalink to this headline">¶</a></h1>

File docs/_build/html/objects.inv

 # Version: 0.2
 restclient mod resource.html
 restclient.rest.Resource.put method resource.html
+restclient.rest.RestClient.put method resource.html
 restclient.rest.Resource.get method resource.html
 restclient.http.HTTPClient class httpclient.html
 restclient.rest.Resource class resource.html
 restclient.http.createHTTPClient function httpclient.html
-restclient.rest.RestClient.Resource.head method resource.html
-restclient.rest.RestClient.Resource.get method resource.html
 restclient.http.HTTPLib2HTTPClient class httpclient.html
 restclient.http.getDefaultHTTPClient function httpclient.html
 restclient.http.Urllib2HTTPClient class httpclient.html
+restclient.rest.RestClient.get method resource.html
 restclient.rest.Resource.clone method resource.html
+restclient.rest.RestClient.post method resource.html
 restclient.RestClient.httpclient attribute resource.html
 restclient.rest.RestClient class resource.html
+restclient.rest.RestClient.delete method resource.html
 restclient.rest.Unauthorized exception resource.html
 restclient.http.Urllib2HTTPClient.__init__ method httpclient.html
 restclient.rest.RequestFailed exception resource.html
 restclient.rest.Resource.post method resource.html
 restclient.rest.Resource.head method resource.html
 restclient.rest.Resource.delete method resource.html
-restclient.rest.RestClient.Resource.delete method resource.html
-restclient.rest.RestClient.Resource.put method resource.html
 restclient.Resource.uri attribute resource.html
-restclient.rest.RestClient.Resource.post method resource.html
+restclient.rest.RestClient.make_request method resource.html
 restclient.Resource.httpclient attribute resource.html
+restclient.rest.RestClient.head method resource.html
 restclient.rest.Resource.get_status_code method resource.html
 restclient.http.HTTPClient.request method httpclient.html
 restclient.http.CurlHTTPClient class httpclient.html

File docs/_build/html/resource.html

 
 <p><strong>Methods</strong></p>
 <dl class="method">
-<dt id="restclient.rest.RestClient.Resource.get">
-<!--[restclient.rest.RestClient.Resource.get]--><tt class="descclassname">Resource.</tt><tt class="descname">get</tt><big>(</big><em>path=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.Resource.get" title="Permalink to this definition">¶</a></dt>
+<dt id="restclient.rest.RestClient.get">
+<!--[restclient.rest.RestClient.get]--><tt class="descname">get</tt><big>(</big><em>uri</em>, <em>path=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.get" title="Permalink to this definition">¶</a></dt>
 <dd><p>HTTP GET</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>uri</em> &#8211; str, uri on which you make the request</li>
 <li><em>path</em> &#8211; string  additionnal path to the uri</li>
 <li><em>headers</em> &#8211; dict, optionnal headers that will
 be added to HTTP request.</li>
 </dd></dl>
 
 <dl class="method">
-<dt id="restclient.rest.RestClient.Resource.head">
-<!--[restclient.rest.RestClient.Resource.head]--><tt class="descclassname">Resource.</tt><tt class="descname">head</tt><big>(</big><em>path=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.Resource.head" title="Permalink to this definition">¶</a></dt>
+<dt id="restclient.rest.RestClient.head">
+<!--[restclient.rest.RestClient.head]--><tt class="descname">head</tt><big>(</big><em>uri</em>, <em>path=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.head" title="Permalink to this definition">¶</a></dt>
 <dd><p>HTTP HEAD</p>
 <p>see GET for params description.</p>
 </dd></dl>
 
 <dl class="method">
-<dt id="restclient.rest.RestClient.Resource.delete">
-<!--[restclient.rest.RestClient.Resource.delete]--><tt class="descclassname">Resource.</tt><tt class="descname">delete</tt><big>(</big><em>path=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.Resource.delete" title="Permalink to this definition">¶</a></dt>
+<dt id="restclient.rest.RestClient.delete">
+<!--[restclient.rest.RestClient.delete]--><tt class="descname">delete</tt><big>(</big><em>uri</em>, <em>path=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.delete" title="Permalink to this definition">¶</a></dt>
 <dd><p>HTTP DELETE</p>
 <p>see GET for params description.</p>
 </dd></dl>
 
 <dl class="method">
-<dt id="restclient.rest.RestClient.Resource.post">
-<!--[restclient.rest.RestClient.Resource.post]--><tt class="descclassname">Resource.</tt><tt class="descname">post</tt><big>(</big><em>path=None</em>, <em>payload=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.Resource.post" title="Permalink to this definition">¶</a></dt>
+<dt id="restclient.rest.RestClient.post">
+<!--[restclient.rest.RestClient.post]--><tt class="descname">post</tt><big>(</big><em>uri</em>, <em>path=None</em>, <em>body=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.post" title="Permalink to this definition">¶</a></dt>
 <dd><p>HTTP POST</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">Payload:</th><td class="field-body"><p class="first">string passed to the body of the request</p>
-</td>
-</tr>
-<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
+<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
+<li><em>uri</em> &#8211; str, uri on which you make the request</li>
 <li><em>path</em> &#8211; string  additionnal path to the uri</li>
 <li><em>headers</em> &#8211; dict, optionnal headers that will
 be added to HTTP request.</li>
 </ul>
 </td>
 </tr>
+<tr class="field"><th class="field-name">Body:</th><td class="field-body"><p class="first last">string passed to the body of the request</p>
+</td>
+</tr>
 </tbody>
 </table>
 </dd></dl>
 
 <dl class="method">
-<dt id="restclient.rest.RestClient.Resource.put">
-<!--[restclient.rest.RestClient.Resource.put]--><tt class="descclassname">Resource.</tt><tt class="descname">put</tt><big>(</big><em>path=None</em>, <em>payload=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.Resource.put" title="Permalink to this definition">¶</a></dt>
+<dt id="restclient.rest.RestClient.put">
+<!--[restclient.rest.RestClient.put]--><tt class="descname">put</tt><big>(</big><em>uri</em>, <em>path=None</em>, <em>body=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.put" title="Permalink to this definition">¶</a></dt>
 <dd><p>HTTP PUT</p>
 <p>see POST for params description.</p>
 </dd></dl>
 
+<dl class="method">
+<dt id="restclient.rest.RestClient.make_request">
+<!--[restclient.rest.RestClient.make_request]--><tt class="descname">make_request</tt><big>(</big><em>method</em>, <em>uri</em>, <em>path=None</em>, <em>body=None</em>, <em>headers=None</em>, <em>**params</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient.make_request" title="Permalink to this definition">¶</a></dt>
+<dd><p>Perform HTTP call support GET, HEAD, POST, PUT and DELETE.</p>
+<p>Usage example, get friendpaste page :</p>
+<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">restclient</span> <span class="kn">import</span> <span class="n">RestClient</span>
+<span class="n">client</span> <span class="o">=</span> <span class="n">RestClient</span><span class="p">()</span>
+<span class="n">page</span> <span class="o">=</span> <span class="n">resource</span><span class="o">.</span><span class="n">request</span><span class="p">(</span><span class="s">&#39;GET&#39;</span><span class="p">,</span> <span class="s">&#39;http://friendpaste.com&#39;</span><span class="p">)</span>
+</pre></div>
+</div>
+<p>Or get a paste in JSON :</p>
+<div class="highlight-python"><pre>from restclient import RestClient
+client = RestClient()
+client.make_request('GET', 'http://friendpaste.com/5rOqE9XTz7lccLgZoQS4IP'),
+    headers={'Accept': 'application/json'})</pre>
+</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 simple">
+<li><em>method</em> &#8211; str, the HTTP action to be performed: 
+&#8216;GET&#8217;, &#8216;HEAD&#8217;, &#8216;POST&#8217;, &#8216;PUT&#8217;, or &#8216;DELETE&#8217;</li>
+<li><em>path</em> &#8211; str or list, path to add to the uri</li>
+<li><em>data</em> &#8211; str or string or any object that could be
+converted to JSON.</li>
+<li><em>headers</em> &#8211; dict, optionnal headers that will
+be added to HTTP request.</li>
+<li><em>params</em> &#8211; Optionnal parameterss added to the request.</li>
+</ul>
+</td>
+</tr>
+<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">str.</p>
+</td>
+</tr>
+</tbody>
+</table>
+</dd></dl>
+
 </dd></dl>
 
 </div>

File docs/_build/html/searchindex.js

-Search.setIndex({desctypes:{"0":"method","1":"class","2":"function","3":"attribute","4":"exception"},terms:{serv:1,urllib2httpclien:4,all:1,code:[0,1],text:1,over:1,rest:[0,1,3],veri:4,actuib:4,own:1,through:[0,3],file:3,follow:3,mainli:0,yet:0,languag:1,paramet:[1,4],xml:1,absolut:1,style:3,specif:4,depend:[1,4],expos:0,wed:3,except:[3,1],param:[1,4],should:[3,4],add:[1,4],version:2,dict:[1,4],"__call__":1,pass:1,httplib2httpclient:[1,4],applic:[0,1],sourc:[3,2],"return":4,string:1,later:2,get:[0,1,2,3,4],python:[0,2,3,4],powerful:4,auth:4,know:3,"import":[0,1,4],report:3,brows:3,requir:[3,2],restclient:[0,1,2,3,4],httpbasicauthhandl:4,like:3,getdefaulthttpcli:4,benoitc:2,authent:1,patch:4,"default":[1,4],resr2:1,common:1,timeout:4,contain:3,found:[],page:[0,3],mean:4,altern:2,pthon:2,set:[1,4],repres:[1,4],some:4,direct:3,past:0,see:[1,4],curlhttpclient:4,toctre:3,fail:[],http:[0,1,2,3,4],server:1,librari:0,index:3,statu:1,simplecouchdb:2,make_request:0,someth:4,pypast:1,urllib:4,payload:1,access:[1,4],delet:[3,1,4],tracker:3,adapt:3,call:[0,3,4],"new":1,setdefaulthttpcli:4,get_status_cod:1,method:[1,4],refer:3,"3xdqq8g83llzvwgcewdwru":1,full:1,run:4,proxi:[1,4],kei:0,htpp:4,usag:0,engura:2,fisrt:3,symlink:2,bodi:[1,4],step:3,base:[1,4],here:4,repositori:2,releas:2,org:2,post:[3,1,4],don:4,optionn:[1,4],about:[3,1],last:[2,1],friendpast:[0,1],could:[2,1],manag:4,microframework:3,instanc:[1,4],constructor:4,action:3,mani:4,implement:4,createhttpcli:4,com:[0,1],oper:4,via:2,httppasswordmgrwithdefaultrealm:4,additionn:1,instanti:1,pythonpath:2,modul:[0,1,3,4],inspir:3,prefer:4,easy_instal:2,put:[3,1,4],api:[0,1],been:4,path:[2,1],instal:[0,1,2,3],your:[2,1,3,4],mercuri:2,alternatli:2,from:[0,1,2,4],wai:4,support:[0,3,4],fast:4,avail:2,start:[0,3],json:[0,1],handler:4,master:3,includ:[1,4],basic:[1,4],interfac:[1,4],httpclient:[1,4],"function":[3,4],head:[3,1,4],option:1,unexpect:1,auth_handl:4,copi:2,setuptool:2,search:3,specifi:3,anywher:2,least:3,indic:3,requestfail:1,cheeseshop:2,recommand:4,bug:3,"case":4,also:[2,1,4],none:[1,4],pycurl:[1,4],provid:1,setup:2,properti:1,dev:2,directori:2,can:[2,1,3,4],str:[1,4],error:1,dec:3,root:3,update_uri:1,"5roqe9xtz7lcclgzoqs4ip":[0,1],featur:[0,3],quickstart:3,creat:[3,4],descript:[0,1],sudo:2,site:2,accept:[0,1],edfault:[],packag:2,have:[0,4],tabl:3,need:[2,1,3,4],revis:1,curl:4,"__init__":4,alwai:2,develop:[3,2],welcom:[3,4],want:[0,1,4],perform:[0,3,4],titl:1,make:[2,1],add_password:4,header:[0,1,4],unauthor:1,snippet:1,sinatra:3,when:[1,4],exampl:[0,1,4],read:0,resourcenotfound:1,which:4,subdirectori:2,test:[1,4],add_credenti:4,you:[0,1,2,3,4],document:[0,3],simpl:3,tutorial:0,complet:3,resourc:[0,1,3,4],though:4,our:2,cach:4,clone:[2,1],object:[1,4],urllib2:[1,4],password_mgr:4,most:2,rais:1,authentif:[1,4],respons:[1,4],"class":[3,1],urllib2httpcli:4,recent:2,bitbucket:[3,2],sphinx:3,ani:[1,4],operform:[],url:4,doc:0,camp:3,request:[0,1,4],uri:1,receiv:1,depth:0,client:[0,1,3,4],command:2,thi:[0,1,2,3,4],choos:4,everyth:3,parameterss:1,self:4,httplib2:[1,4]},titles:["Getting Started","Resource","Installation","Welcome to python-restclient&#8217;s documentation!","HTTP Clients"],modules:{restclient:1},descrefs:{"restclient.RestClient":{httpclient:[1,3]},"restclient.rest.RestClient.Resource":{put:[1,0],head:[1,0],"delete":[1,0],post:[1,0],get:[1,0]},"restclient.http":{createHTTPClient:[4,2],setDefaultHTTPClient:[4,2],HTTPLib2HTTPClient:[4,1],CurlHTTPClient:[4,1],Urllib2HTTPClient:[4,1],getDefaultHTTPClient:[4,2],HTTPClient:[4,1]},"restclient.Resource":{uri:[1,3],httpclient:[1,3]},"restclient.rest.Resource":{head:[1,0],get:[1,0],clone:[1,0],"__call__":[1,0],put:[1,0],post:[1,0],get_status_code:[1,0],update_uri:[1,0],"delete":[1,0]},"restclient.http.Urllib2HTTPClient":{"__init__":[4,0]},"restclient.http.HTTPClient":{request:[4,0]},"restclient.rest":{ResourceNotFound:[1,4],Resource:[1,1],RestClient:[1,1],Unauthorized:[1,4],RequestFailed:[1,4]}},filenames:["gettingstarted","resource","installation","index","httpclient"]})
+Search.setIndex({desctypes:{"0":"method","1":"class","2":"function","3":"attribute","4":"exception"},terms:{urllib2httpclien:4,all:1,code:[0,1],text:1,over:1,rest:[0,1,3],veri:4,actuib:4,own:1,through:[0,3],file:3,follow:3,mainli:0,yet:0,languag:1,paramet:[1,4],xml:1,absolut:1,style:3,specif:4,depend:[1,4],expos:0,wed:3,except:[3,1],param:[1,4],should:[3,4],add:[1,4],tracker:3,dict:[1,4],"__call__":1,pass:1,httplib2httpclient:[1,4],applic:[0,1],sourc:[3,2],"return":[1,4],string:1,later:2,get:[0,1,2,3,4],python:[0,2,3,4],powerful:4,auth:4,know:3,"import":[0,1,4],report:3,brows:3,requir:[3,2],restclient:[0,1,2,3,4],search:3,httpbasicauthhandl:4,like:3,getdefaulthttpcli:4,benoitc:2,list:1,authent:1,patch:4,"default":[1,4],resr2:1,common:1,timeout:4,contain:3,found:[],page:[0,1,3],mean:4,altern:2,pthon:2,set:[1,4],repres:[1,4],some:4,direct:3,past:[0,1],see:[1,4],enki:3,toctre:3,fail:[],http:[0,1,2,3,4],server:1,librari:0,index:3,statu:1,simplecouchdb:2,make_request:[0,1],someth:4,pypast:1,urllib:4,payload:1,access:[1,4],delet:[3,1,4],version:2,adapt:3,"new":1,setdefaulthttpcli:4,get_status_cod:1,method:[1,4],refer:3,"3xdqq8g83llzvwgcewdwru":1,full:1,run:4,proxi:[1,4],kei:0,htpp:4,usag:[0,1],curlhttpclient:4,engura:2,fisrt:3,here:4,interfac:[1,4],bodi:[1,4],step:3,base:[1,4],multimedia:3,repositori:2,byth:3,releas:2,org:2,post:[3,1,4],don:4,optionn:[1,4],about:[3,1],last:[2,1],friendpast:[0,1],most:2,could:[2,1],respons:[1,4],manag:4,microframework:3,instanc:[1,4],decid:3,constructor:4,action:[3,1],mani:4,implement:4,createhttpcli:4,com:[0,1],oper:4,via:2,httppasswordmgrwithdefaultrealm:4,additionn:1,instanti:1,pythonpath:2,modul:[0,1,3,4],inspir:3,prefer:4,easy_instal:2,put:[1,4],api:[0,1],been:4,path:[2,1],instal:[0,1,2,3],your:[2,1,3,4],symlink:2,mercuri:2,alternatli:2,from:[0,1,2,4],wai:4,support:[0,1,3,4],fast:4,avail:2,start:[0,3],json:[0,1],handler:4,call:[0,1,3,4],includ:[1,4],basic:[1,4],master:3,httpclient:[1,4],"function":[3,4],head:[1,4],option:1,unexpect:1,auth_handl:4,"public":3,copi:2,setuptool:2,convert:1,specifi:3,anywher:2,least:3,indic:3,requestfail:1,cheeseshop:2,recommand:4,bug:3,serv:1,also:[2,1,4],none:[1,4],pycurl:[1,4],provid:1,setup:2,properti:1,dev:2,project:3,directori:2,can:[2,1,3,4],str:[1,4],error:1,dec:3,root:3,update_uri:1,"5roqe9xtz7lcclgzoqs4ip":[0,1],featur:[0,3],quickstart:3,creat:[3,4],descript:[0,1],sudo:2,site:2,accept:[0,1],edfault:[],packag:2,have:[0,4],tabl:3,need:[2,1,3,4],revis:1,curl:4,"__init__":4,alwai:2,headput:3,develop:[3,2],welcom:[3,4],want:[0,1,4],perform:[0,1,3,4],titl:1,make:[2,1,3],add_password:4,header:[0,1,4],unauthor:1,snippet:1,sinatra:3,when:[1,4],exampl:[0,1,4],read:0,resourcenotfound:1,which:[1,4],subdirectori:2,test:[1,4],add_credenti:4,you:[0,1,2,3,4],document:[0,3],simpl:3,tutorial:0,complet:3,resourc:[0,1,3,4],though:4,our:[3,2],cach:4,clone:[2,1],object:[1,4],urllib2:[1,4],password_mgr:4,"case":4,rais:1,authentif:[1,4],data:1,"class":[3,1],urllib2httpcli:4,recent:2,bitbucket:[3,2],sphinx:3,ani:[1,4],operform:[],url:4,doc:0,camp:3,request:[0,1,4],uri:1,receiv:1,depth:0,client:[0,1,3,4],command:2,thi:[0,1,2,3,4],choos:4,everyth:3,parameterss:1,self:4,httplib2:[1,4]},titles:["Getting Started","Resource","Installation","Welcome to python-restclient&#8217;s documentation!","HTTP Clients"],modules:{restclient:1},descrefs:{"restclient.RestClient":{httpclient:[1,3]},"restclient.http.Urllib2HTTPClient":{"__init__":[4,0]},"restclient.http.HTTPClient":{request:[4,0]},"restclient.http":{createHTTPClient:[4,2],setDefaultHTTPClient:[4,2],HTTPLib2HTTPClient:[4,1],CurlHTTPClient:[4,1],Urllib2HTTPClient:[4,1],getDefaultHTTPClient:[4,2],HTTPClient:[4,1]},"restclient.Resource":{uri:[1,3],httpclient:[1,3]},"restclient.rest.Resource":{head:[1,0],get:[1,0],clone:[1,0],"__call__":[1,0],put:[1,0],post:[1,0],get_status_code:[1,0],update_uri:[1,0],"delete":[1,0]},"restclient.rest.RestClient":{head:[1,0],get:[1,0],put:[1,0],post:[1,0],make_request:[1,0],"delete":[1,0]},"restclient.rest":{ResourceNotFound:[1,4],Resource:[1,1],RestClient:[1,1],Unauthorized:[1,4],RequestFailed:[1,4]}},filenames:["gettingstarted","resource","installation","index","httpclient"]})

File docs/resource.txt

 
     **Methods**
 
-    .. automethod:: restclient.rest.Resource.get
+    .. automethod:: restclient.rest.RestClient.get
 
-    .. automethod:: restclient.rest.Resource.head
+    .. automethod:: restclient.rest.RestClient.head
 
-    .. automethod:: restclient.rest.Resource.delete
+    .. automethod:: restclient.rest.RestClient.delete
 
-    .. automethod:: restclient.rest.Resource.post
+    .. automethod:: restclient.rest.RestClient.post
 
-    .. automethod:: restclient.rest.Resource.put
+    .. automethod:: restclient.rest.RestClient.put
 
-    .. automethod:: restclient.rest.Resource.make_request
+    .. automethod:: restclient.rest.RestClient.make_request
 
 
 Exceptions