summaryrefslogtreecommitdiff
path: root/README.rst
blob: c3c06de0f19610321dcf22028ae0afee641b971a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
===============
Macaroon Bakery
===============

A Python library for working with macaroons.


Installation
------------
The easiest way to install macaroonbakery is via pip::

    $ pip install macaroonbakery

macaroonbakery was developed around pymacaroons. On ubuntu, you
can get libsodium from a ppa::

	$ sudo add-apt-repository ppa:yellow/ppa -y
	$ apt-get install libsodium13

Usage
-----
Interacting with a protected url, you can use the BakeryAuth provided to deal
with the macaroon bakery

    >>> from macaroonbakery import httpbakery
    >>> jar = requests.cookies.RequestsCookieJar()
    >>> resp = requests.get('some protected url',
                            cookies=jar,
                            auth=httpbakery.BakeryAuth(cookies=jar))
    >>> resp.raise_for_status()


You can use any cookie storage you'd like so next subsequent calls the macaroon
saved in the cookie jar will be directly used and will not require
any other authentication (for example, cookielib.FileCookieJar).