Commits

benoitc  committed 5d7fbea

regen doc.

  • Participants
  • Parent commits 0bfe6df

Comments (0)

Files changed (13)

File docs/_build/doctrees/console.doctree

Binary file modified.

File docs/_build/doctrees/environment.pickle

Binary file modified.

File docs/_build/doctrees/gettingstarted.doctree

Binary file modified.

File docs/_build/doctrees/index.doctree

Binary file modified.

File docs/_build/doctrees/installation.doctree

Binary file modified.

File docs/_build/doctrees/resource.doctree

Binary file modified.

File docs/_build/doctrees/transports.doctree

Binary file modified.

File docs/_build/doctrees/whatsnew.doctree

Binary file modified.

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

 
 .. rubric:: Everything you need to know about py-restclient.
 
-**Py-restclient** is simple **REST client for Python**, inspired bythe microframework (Camping, Sinatra) style of specifying actions: get,headput, post, delete. 
+**Py-restclient** is simple **REST client for Python**, inspired bythe
+microframework (Camping, Sinatra) style of specifying actions: get, head, put, post, delete. 
 
 Made by `Enki Multimedia <http://www.e-engura.org>`_ for one of our project and we decided to make it public.
 
    resource
    transports
 
-* 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/>`_.
+* Follow development on `Bitbucket <http://bitbucket.org/benoitc/py-restclient/>`_.
+* Report bugs, report features and browse the source through `Tracker <http://bitbucket.org/benoitc/py-restclient/issues/>`_.
 
 
 Indices and tables

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 py-restclient.</p>
-<p><strong>Py-restclient</strong> is simple <strong>REST client for Python</strong>, inspired bythe microframework (Camping, Sinatra) style of specifying actions: get,headput, post, delete.</p>
+<p><strong>Py-restclient</strong> is simple <strong>REST client for Python</strong>, inspired bythe
+microframework (Camping, Sinatra) style of specifying actions: get, head, put, post, delete.</p>
 <p>Made by <a class="reference external" 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">
 </li>
 </ul>
 <ul class="simple">
-<li>Follow development on <a class="reference external" 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 external" href="http://www.bitbucket.org/benoitc/python-restclient/issues/">Tracker</a>.</li>
+<li>Follow development on <a class="reference external" href="http://bitbucket.org/benoitc/py-restclient/">Bitbucket</a>.</li>
+<li>Report bugs, report features and browse the source through <a class="reference external" href="http://bitbucket.org/benoitc/py-restclient/issues/">Tracker</a>.</li>
 </ul>
 </div>
 <div class="section" id="indices-and-tables">

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.rest.RestClient class resource.html
+restclient.transport.CurlTransport.__init__ method transports.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.Resource.update_uri method resource.html
+restclient.rest.RequestFailed exception 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.transport.CurlTransport.__init__ method transports.html
+restclient.rest.RestClient class resource.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.RequestFailed exception resource.html
+restclient.rest.Resource.update_uri method resource.html
 restclient.transport.getDefaultHTTPTransport function transports.html
 restclient.transport.HTTPTransportBase.__init__ method transports.html

File docs/_build/html/resource.html

 <h2>Resource class<a class="headerlink" href="#resource-class" title="Permalink to this headline">¶</a></h2>
 <dl class="class">
 <dt id="restclient.rest.Resource">
-<!--[restclient.rest.Resource]-->class <tt class="descclassname">restclient.rest.</tt><tt class="descname">Resource</tt><big>(</big><em>uri</em>, <em>transport=None</em><big>)</big><a class="headerlink" href="#restclient.rest.Resource" title="Permalink to this definition">¶</a></dt>
+<!--[restclient.rest.Resource]-->class <tt class="descclassname">restclient.rest.</tt><tt class="descname">Resource</tt><big>(</big><em>uri</em>, <em>transport=None</em>, <em>headers=None</em><big>)</big><a class="headerlink" href="#restclient.rest.Resource" title="Permalink to this definition">¶</a></dt>
 <dd><p>A class that can be instantiated for access to a RESTful resource, 
 including authentication.</p>
 <p>It can use pycurl, urllib2, httplib2 or any interface over
 decide that keys don&#8217;t need to be encoded.</p>
 <dl class="class">
 <dt id="restclient.rest.RestClient">
-<!--[restclient.rest.RestClient]-->class <tt class="descclassname">restclient.rest.</tt><tt class="descname">RestClient</tt><big>(</big><em>transport=None</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient" title="Permalink to this definition">¶</a></dt>
+<!--[restclient.rest.RestClient]-->class <tt class="descclassname">restclient.rest.</tt><tt class="descname">RestClient</tt><big>(</big><em>transport=None</em>, <em>headers=None</em><big>)</big><a class="headerlink" href="#restclient.rest.RestClient" title="Permalink to this definition">¶</a></dt>
 <dd><p>Basic rest client</p>
 <div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">res</span> <span class="o">=</span> <span class="n">RestClient</span><span class="p">()</span>
 <span class="gp">&gt;&gt;&gt; </span><span class="n">xml</span> <span class="o">=</span> <span class="n">res</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">&#39;http://pypaste.com/about&#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,4],code:[0,4],friedpast:[],follow:3,make_request:0,decid:[3,4],depend:4,send:1,program:1,sourc:[3,2],string:[1,4],httptransport:6,brows:3,list:4,item:5,direct:3,proxy_password:6,past:[0,4,1],pass:4,port:1,index:3,what:[3,5],sun: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:[6,4],proxy_us:6,path:[2,4],method:[1,4,6],modifi:5,valu:1,optionn:[6,4],search:3,later:2,user_timelin:1,action:[3,4],chang:4,via:[2,4,6],modul:[0,4,3],prefer:6,releas:2,api:[0,4],encode_kei:4,instal:[0,4,2,3],feb:5,call:[0,4,6,3],type:[5,1,6],more:6,indic:3,cheeseshop:2,recommand:6,cach:6,none:[6,4],pycurl:[6,4],setup:2,dev:2,can:[2,4,6,3],dec:[3,5],root:3,aliv:5,overrid:4,malform:4,quickstart:3,createhttptransport:6,sudo:2,accept:[5,0,4,1],want:[0,4,6],alwai:2,anoth:[],charset: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],constructor:6,befor:[],mai:4,authentif:[6,4],data:[5,4],final_url:5,attempt:4,perform:[0,1,4,6,3],allow:1,help:1,over:4,through:[0,3],mainli:0,paramet:[6,4],style:3,fix:[3,5],"return":[6,4],python:[5,0,2,3],safe:4,httplib2:[2,4,6],now:5,httplib:6,restclient:[0,1,2,3,4,5,6],benoitc:[1,2],authent:4,timeout:6,found:4,unicod:5,mean:4,pthon:2,connect:[5,6],our:[3,2],extract:4,rev:1,content:[5,1,6],rewrit:[],adapt:3,print:[0,5],proxi:[1,4,6],given:4,like:[3,1,6,5],base:[6,4],byth:3,put:[6,4],org:[5,2,6],"byte":5,friendpast:[0,4,1],could:[2,4,5],keep:5,length:5,isn:[],oper:6,rang:5,headput:3,number:1,date:5,least:3,payload:4,alternatli:2,start:[0,3],messag:[1,4,6],mercuri:2,master:3,curltransport:6,consol:[3,1],option:[1,4],copi:2,setuptool:2,specifi:[3,4],than:[6,4],serv:4,notfound:4,provid:4,remov:[],charact:4,project:3,str:[6,4],update_uri:4,anywher:2,packag:2,have:[0,6,5],tabl:3,need:[2,1,4,3],unexpect:4,sinatra:3,client:[0,1,3,4,5,6],which:[6,4],command:[1,2],simplifi:[],though:6,usernam:1,setdefaulthttptransport:6,object:[5,4,6],most:2,"class":[3,4],don:4,url:[1,4,6,5],doc:0,camp:3,request:[0,4,6,1],uri:[1,4],multimedia:3,show:1,text:[1,4,6,5],actuib:6,xml:4,absolut:4,onli:4,should:[3,6],dict:[5,4,6],"__call__":4,get:[0,1,2,3,4,5,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:[3,4,6,5],fail:4,statu:[1,4,6,5],simplecouchdb:2,charat:4,someth:6,urllib:6,"import":[0,4,6,5],email:6,altern:2,kei:[0,4,1],engura:[5,2,6],fisrt:3,proxy_port:6,entir:4,last:[5,2],wed:[3,5],instanc:[6,4],com:[0,4,1],instanti:4,inspir:3,header:[5,0,4,6,1],resr2:4,been:[5,6],json:[0,4,1],basic:[6,4],imag:6,ani:[1,4,6],resourceresult:[],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:[],binari:5,html:[5,4,6],resourcenotfound:4,document:[0,3],complet:3,status:1,http:[0,1,2,3,4,5,6],utf8: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],"__dict__":5,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,gmt:5,real:5,applic:[0,4,1],read:[0,1],nginx:5,know:3,httprespons:[5,6],name:1,specif:6,success:4,filenam:1,anyth:4,server:[5,4],output:1,page:[5,0,4,6,3],twitter:1,some:6,back:1,enki:3,toctre:3,transport:[3,4,6],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,from:[0,4,2,1,5,6],post:[3,4,6,1],about:[3,4],manag:[5,6],microframework:3,act:5,own:[1,4],additionn:4,pythonpath:2,encod:[3,4,5],easy_instal:2,your:[2,1,4,3],support:[0,4,6,3],fast:6,avail:[1,2],gif:6,interfac:[6,4],includ:4,httpclient:[6,4],"function":[3,6],head:[6,4],form:1,renam:[],line:1,"true":[1,4],bug:3,info:6,also:[5,2,6],made:3,utf:4,"default":[6,4],xxxxxxx:[6,1],"5roqe9xtz7lcclgzoqs4ip":[0,4],featur:[0,3],creat:[3,1,6],"int":6,repres:[6,4],file:[3,4,1],logo:6,curl:[5,6],probabl:4,password:[6,1],titl:[1,4],when:[6,4],other:4,librari:0,test:[1,4,6],you:[0,1,2,3,4,5,6],urllib2:[6,4],bitbucket:[3,2],sphinx:3,directori:2,descript:[0,4],depth:0,time: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.2","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],ResourceNotFound:[4,4],RequestError:[4,4],RequestFailed:[4,4]},"restclient.transport":{createHTTPTransport:[6,1],setDefaultHTTPTransport:[6,1],HTTPLib2Transport:[6,2],getDefaultHTTPTransport:[6,1],HTTPResponse:[6,2],CurlTransport:[6,2],HTTPTransportBase:[6,2]}},filenames:["gettingstarted","console","installation","index","resource","whatsnew","transports"]})
+Search.setIndex({desctypes:{"0":"method","1":"function","2":"class","3":"attribute","4":"exception"},terms:{all:[5,4],code:[0,4],friedpast:[],follow:3,make_request:0,decid:[3,4],depend:4,send:1,program:1,sourc:[3,2],string:[1,4],httptransport:6,brows:3,list:4,item:5,direct:3,proxy_password:6,past:[0,4,1],pass:4,port:1,index:3,what:[3,5],sun:5,pypast:4,access:[6,4],delet:[3,4,6],version:[1,2],"new":[3,4,5],requesterror:4,method:[1,4,6],full:[1,4],unauthor:4,here:6,bodi:[6,4],proxy_us:6,path:[2,4],modifi:5,valu:1,optionn:[6,4],search:3,user_timelin:1,action:[3,4],chang:4,via:[2,4,6],modul:[0,4,3],prefer:6,put:[3,4,6],api:[0,4],encode_kei:4,instal:[0,4,2,3],feb:5,call:[0,4,6,3],type:[5,1,6],more:6,accept:[0,1,4,5],cheeseshop:2,recommand:6,cach:6,none:[6,4],pycurl:[6,4],setup:2,dev:2,can:[2,4,6,3],dec:[3,5],root:3,aliv:5,overrid:4,malform:4,quickstart:3,createhttptransport:6,sudo:2,indic:3,want:[0,4,6],alwai:2,anoth:[],charset: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],constructor:6,befor:[],date:5,authentif:[6,4],data:[5,4],final_url:5,attempt:4,receiv:4,allow:1,help:1,over:4,through:[0,3],mainli:0,paramet:[6,4],style:3,fix:[3,5],"return":[6,4],python:[5,0,2,3],safe:4,httplib2:[2,4,6],now:5,httplib:6,name:1,benoitc:[1,2],authent:4,timeout:6,found:4,unicod:5,mean:4,pthon:2,connect:[5,6],our:[3,2],extract:4,rev:1,content:[5,1,6],rewrit:[],adapt:3,print:[0,5],proxi:[1,4,6],given:4,base:[6,4],byth:3,releas:2,org:[5,2,6],"byte":5,friendpast:[0,4,1],could:[2,4,5],success:4,keep:5,length:5,isn:[],oper:6,rang:5,headput:[],number:1,mai:4,least:3,payload:4,alternatli:2,start:[0,3],messag:[1,4,6],mercuri:2,master:3,curltransport:6,consol:[3,1],option:[1,4],"public":3,copi:2,setuptool:2,specifi:[3,4],than:[6,4],serv:4,notfound:4,remot:4,remov:[],charact:4,project:3,str:[6,4],update_uri:4,anywher:2,packag:2,have:[0,6,5],tabl:3,need:[2,1,4,3],featur:[0,3],unexpect:4,sinatra:3,client:[0,1,3,4,5,6],which:[6,4],command:[1,2],simplifi:[],though:6,usernam:1,setdefaulthttptransport:6,object:[5,4,6],most:2,"class":[3,4],don:4,url:[5,4,6,1],doc:0,camp:3,request:[0,4,6,1],uri:[1,4],multimedia:3,show:1,text:[5,4,6,1],actuib:6,xml:4,absolut:4,onli:4,should:[3,6],dict:[5,4,6],"__call__":4,get:[0,1,2,3,4,5,6],report:3,requir:[2,4,3],patch:6,provid:4,stuff:1,common:4,contain:3,set:[6,4],transportthat:6,httplib2transport:[6,4],see:[5,4,6],result:[1,4],respons:[3,4,6,5],fail:4,statu:[5,4,6,1],simplecouchdb:2,charat:4,someth:6,urllib:6,"import":[0,4,6,5],email:6,altern:2,kei:[0,4,1],engura:[5,2,6],fisrt:3,proxy_port:6,entir:4,last:[5,2],proxy_host:6,instanc:[6,4],com:[0,4,1],instanti:4,inspir:3,header:[0,1,4,6,5],resr2:4,been:[5,6],json:[0,4,1],basic:[6,4],imag:6,ani:[1,4,6],resourceresult:[],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,perform:[0,1,4,6,3],make:[2,4,3],same:[],binari:5,html:[5,4,6],resourcenotfound:4,document:[0,3],complet:3,status:1,http:[0,1,2,3,4,5,6],utf8: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],"__dict__":5,yet:0,languag:[1,4],httptransportbas:[6,4],"1po5toc012qefyos3b3raa":1,expos:0,wed:[3,5],except:[3,4],param:[6,4],add:4,tring:4,input:1,gmt:5,real:5,applic:[0,4,1],read:[0,1],nginx:5,know:3,httprespons:[5,6],restclient:[0,1,2,3,4,5,6],like:[3,1,6,5],specif:6,filenam:1,anyth:4,server:[5,4],output:1,page:[5,0,4,6,3],twitter:1,some:6,back:1,enki:3,toctre:3,librari:0,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,from:[0,1,2,5,4,6],post:[3,4,6,1],about:[3,4],manag:[5,6],microframework:3,act:5,own:[1,4],additionn:4,pythonpath:2,encod:[3,4,5],easy_instal:2,your:[2,1,4,3],support:[0,4,6,3],fast:6,avail:[1,2],gif:6,interfac:[6,4],includ:4,httpclient:[6,4],"function":[3,6],head:[3,4,6],form:1,renam:[],line:1,"true":[1,4],bug:3,info:6,also:[5,2,6],made:3,utf:4,"default":[6,4],xxxxxxx:[6,1],"5roqe9xtz7lcclgzoqs4ip":[0,4],later:2,creat:[3,1,6],"int":6,repres:[6,4],file:[3,4,1],logo:6,curl:[5,6],probabl:4,password:[6,1],titl:[1,4],when:[6,4],other:4,transport:[3,4,6],test:[1,4,6],you:[0,1,2,3,4,5,6],urllib2:[6,4],bitbucket:[3,2],sphinx:3,directori:2,descript:[0,4],depth:0,time: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.2","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],ResourceNotFound:[4,4],RequestError:[4,4],RequestFailed:[4,4]},"restclient.transport":{createHTTPTransport:[6,1],setDefaultHTTPTransport:[6,1],HTTPLib2Transport:[6,2],getDefaultHTTPTransport:[6,1],HTTPResponse:[6,2],CurlTransport:[6,2],HTTPTransportBase:[6,2]}},filenames:["gettingstarted","console","installation","index","resource","whatsnew","transports"]})