Commits

Anonymous committed db89733

regen

Comments (0)

Files changed (15)

docs/_build/doctrees/environment.pickle

Binary file modified.

docs/_build/doctrees/gettingstarted.doctree

Binary file modified.

docs/_build/doctrees/httpclient.doctree

Binary file modified.

docs/_build/doctrees/index.doctree

Binary file modified.

docs/_build/doctrees/resource.doctree

Binary file modified.

docs/_build/html/_sources/gettingstarted.txt

 
     from restclient import RestClient
     client = RestClient()
-    client.make_request('GET', 'http://friendpaste.com/5rOqE9XTz7lccLgZoQS4IP',
+    client.make_request('GET', 
+        'http://friendpaste.com/5rOqE9XTz7lccLgZoQS4IP'),
     headers={'Accept': 'application/json'})
 

docs/_build/html/_sources/httpclient.txt

 ============
 .. module:: restclient
 
-Http Clients are class based on :mod:`restclient.http.HTTPClient` that
-operform http operations.
+HTTP Clients are object based on :mod:`restclient.http.HTTPClient` that
+perform HTPP operations.
 
 You can choose the one you want as httpclient in Resource or RestClient:
 

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 by the
+microframework (Camping, Sinatra) style of specifying actions: get, head
+put, post, delete.
 
 Fisrt steps
 ===========
    resource
    httpclient
 
-* Follow developent on `Bitbucket <http://www.bitbucket.org/benoitc/python-restclient/overview/>`_.
+* Follow development on `Bitbucket <http://www.bitbucket.org/benoitc/python-restclient/overview/>`_.
 * Report bugs, report features and browse the source through `Tracker <http://www.bitbucket.org/benoitc/python-restclient/issues/>`_.
 
 

docs/_build/html/_sources/resource.txt

 
 .. module:: restclient
 
-This module provide a common interface for all HTTP request. This
-module make HTTP request using `Pycurl`_ by edfault if installed or
+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`_.
 
 Example: 

docs/_build/html/genindex.html

 <dt><a href="resource.html#restclient.rest.Resource">Resource (class in restclient.rest)</a></dt>
 <dt><a href="resource.html#restclient.rest.ResourceNotFound">ResourceNotFound</a></dt></dl></td><td width="33%" valign="top"><dl>
 <dt><a href="resource.html#restclient.rest.RestClient">RestClient (class in restclient.rest)</a></dt>
-<dt><a href="resource.html#module-restclient">restclient (module)</a>, <a href="httpclient.html#module-restclient">[1]</a></dt>
+<dt><a href="httpclient.html#module-restclient">restclient (module)</a>, <a href="resource.html#module-restclient">[1]</a></dt>
 </dl></td></tr></table>
 
 <h2 id="S">S</h2>

docs/_build/html/gettingstarted.html

 </pre></div>
 </div>
 <p>Or get a paste in JSON :</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">client</span><span class="o">.</span><span class="n">make_request</span><span class="p">(</span><span class="s">&#39;GET&#39;</span><span class="p">,</span> <span class="s">&#39;http://friendpaste.com/5rOqE9XTz7lccLgZoQS4IP&#39;</span><span class="p">,</span>
-<span class="n">headers</span><span class="o">=</span><span class="p">{</span><span class="s">&#39;Accept&#39;</span><span class="p">:</span> <span class="s">&#39;application/json&#39;</span><span class="p">})</span>
-</pre></div>
+<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>
 </div>
 </div>

docs/_build/html/httpclient.html

   
   <div class="section" id="module-restclient">
 <h1>HTTP Clients<a class="headerlink" href="#module-restclient" title="Permalink to this headline">¶</a></h1>
-<p>Http Clients are class based on <tt class="xref docutils literal"><span class="pre">restclient.http.HTTPClient</span></tt> that
-operform http operations.</p>
+<p>HTTP Clients are object based on <tt class="xref docutils literal"><span class="pre">restclient.http.HTTPClient</span></tt> that
+perform HTPP operations.</p>
 <p>You can choose the one you want as httpclient in Resource or RestClient:</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">restclient.http</span> <span class="kn">import</span> <span class="n">CurlHTTPClient</span>
 <span class="n">httpclient</span> <span class="o">=</span> <span class="n">CurlHTTPClient</span><span class="p">()</span>

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 REST client for Python, 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 by the
+microframework (Camping, Sinatra) style of specifying actions: get, head
+put, post, delete.</p>
 </div>
 <div class="section" id="fisrt-steps">
 <h1>Fisrt steps<a class="headerlink" href="#fisrt-steps" title="Permalink to this headline">¶</a></h1>
 </li>
 </ul>
 <ul class="simple">
-<li>Follow developent on <a class="reference" href="http://www.bitbucket.org/benoitc/python-restclient/overview/">Bitbucket</a>.</li>
+<li>Follow development on <a class="reference" href="http://www.bitbucket.org/benoitc/python-restclient/overview/">Bitbucket</a>.</li>
 <li>Report bugs, report features and browse the source through <a class="reference" href="http://www.bitbucket.org/benoitc/python-restclient/issues/">Tracker</a>.</li>
 </ul>
 </div>

docs/_build/html/resource.html

   
   <div class="section" id="module-restclient">
 <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 request. This
-module make HTTP request using <a class="reference" href="http://pycurl.sourceforge.net/">Pycurl</a> by edfault if installed or
+<p>This module provide a common interface for all HTTP requests. This
+module make HTTP requests using <a class="reference" href="http://pycurl.sourceforge.net/">Pycurl</a> by default if installed or
 <a class="reference" href="http://docs.python.org/library/urllib2.html">Urllib2</a> if not. You could also use <a class="reference" 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>

docs/_build/html/searchindex.js

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