Commits

Anonymous committed c21b780

regen

  • Participants
  • Parent commits 92ee02c

Comments (0)

Files changed (6)

File docs/_build/doctrees/environment.pickle

Binary file modified.

File docs/_build/doctrees/whatsnew.doctree

Binary file modified.

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

 * :mod:`restclient.http` have renamed to :mod:`restclient.transport`. In
 the same time all "clients" are now called "transports".
 
-* urllib2 ytransport have been removed, Now httplib2 is used when pycurl
+* urllib2 transport have been removed, Now httplib2 is used when pycurl
   isn't installed. This change was needed to simplify the code. And
   there was no need to rewrite another httplib2 transport but based on
   urllib2.
 Support of File objects as body
 -------------------------------
 
-Now a body could be file object. If you use httplib2 all the content
+Now a body could be a File object. If you use httplib2 all the content
 will be read before sending. Pycurl will send it as it read.
 
 
 Url encoding
 ------------
 
-By default all urls are utf8
-encoded. But you could change default charset, safe characters and
+By default all urls are utf8 encoded. But you could change default charset, safe characters and
 decide that keys don't need to be encoded.
 
 

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

File docs/_build/html/whatsnew.html

 </ul>
 <p>the same time all &#8220;clients&#8221; are now called &#8220;transports&#8221;.</p>
 <ul class="simple">
-<li>urllib2 ytransport have been removed, Now httplib2 is used when pycurl
+<li>urllib2 transport have been removed, Now httplib2 is used when pycurl
 isn&#8217;t installed. This change was needed to simplify the code. And
 there was no need to rewrite another httplib2 transport but based on
 urllib2.</li>
 </div>
 <div class="section" id="support-of-file-objects-as-body">
 <h2>Support of File objects as body<a class="headerlink" href="#support-of-file-objects-as-body" title="Permalink to this headline">¶</a></h2>
-<p>Now a body could be file object. If you use httplib2 all the content
+<p>Now a body could be a File object. If you use httplib2 all the content
 will be read before sending. Pycurl will send it as it read.</p>
 </div>
 <div class="section" id="url-encoding">
 <h2>Url encoding<a class="headerlink" href="#url-encoding" title="Permalink to this headline">¶</a></h2>
-<p>By default all urls are utf8
-encoded. But you could change default charset, safe characters and
+<p>By default all urls are utf8 encoded. But you could change default charset, safe characters and
 decide that keys don&#8217;t need to be encoded.</p>
 <div class="admonition-see-also admonition seealso">
 <p class="first admonition-title">See also</p>