Package: tortilla
Wrapping web APIs made easy.Installation via PIP:pip install tortillaQuick usage overview:>>>importtortilla>>>github=tortilla.wrap('https://api.github.com')>>>user=github.users.get('octocat')>>>user.locationu'San Francisco'The BasicsTortilla uses a bit of magic to wrap APIs. Whenever you get or call an
attribute of a wrapper, the URL is appended by that attribute’s name or
method parameter. Let’s say we have the following code:id,count=71,20api=tortilla.wrap('https://api.example.org')api.video(id).comments.get(count)Every attribute and method call represents a part of the URL:api         -> https://api.example.org
.video      -> /video
(id)        -> /71
.comments   -> /comments
.get(count) -> /20
Final URL   -> https://api.example.org/video/71/comments/20The last part of the chain (.get()) executes the request. It also
(optionally) appends one last part to the URL. Which allows you to do
stuff like this:api.video.get(id)# instead of thisapi.video(id).get()So to summarize, getting attributes is used to define static parts of a
URL and calling them is used to define dynamic parts of a URL.Once you’ve chained everything together, Tortilla will execute the
request and parse the response for you.At the moment, Tortilla only accepts JSON-formatted responses.
Supporting more formats is on the roadmap for future Tortilla versions.The parsed response will bebunchifiedwhich makes dictionary keys
accessible through attributes. So, say we get the following JSON
response for the user ‘john’:{"name":"John Doe"}If we request this with an already created wrapper, we can access the
response data through attributes:>>>user=api.users.get('john')>>>user.nameu'John Doe'HeadersA common requirement for accessing APIs is providing authentication
data. This usually has to be described in the headers of each request.
Tortilla makes it very easy for you to describe those recurring headers:api.config.headers.token='secret authentication token'You can also define custom headers per request:api.endpoint.get(headers={'this':'that'})These headers will be appended to the existing headers of the wrapper.ParametersURL parameters can be defined per request in theparamsoption:api.search.get(params={'q':'search query'})CachingSome APIs have a limit on the amount of requests you can make. In these
cases, caching can be very helpful. You can activate this with thecache_lifetimeparameter:api=tortilla.wrap('https://api.example.org',cache_lifetime=100)All the requests made on this wrapper will now be cached for 100
seconds. If you want to ignore the cache in a specific situation, you
can use theignore_cacheparameter:api.special.request.get(ignore_cache=True)The response will now be reloaded.URL ExtensionsAPIs like Twitter’s require an extension in the URL that specifies the
response format. This can be defined in theextensionparameter:api=tortilla.wrap('https://api.twitter.com/1.1',extension='json')This option can be overridden with every request or subwrap:api.special.endpoint.extension='xml'api.special.endpoint.get(extension='xml')URL SuffixSome APIs uses a trailling slash at the end of URLs like in example below:https://api.example.org/resource/You can add the trailling slash withsuffix="/"argument when wrapping
the API or getting the URL with.url(suffix="/")method:api=tortilla.wrap('https://api.example.org',suffix="/")api.video(71).comments.url()Will return the following URL:api         -> https://api.example.org
.video      -> /video
(id)        -> /71/
Final URL   -> https://api.example.org/video/71/DebuggingActivating debug mode can be done with thedebugparameter:api.debug=True# ORapi=tortilla.wrap('https://api.example.org',debug=True)You can override thedebugparameter per request:api.stuff.get(debug=False)api.other.stuff.get(debug=True)An example using the GitHub API:>>>user=github.users.get('octocat')ExecutingGETrequest:URL:https://api.github.com/users/octocatheaders:{}query:Nonedata:NoneGot200OK:{u'public_repos':5,u'site_admin':...Enjoy your data.