🐍 📓 Python API for Wallabag
Clone or download
foxmask Merge pull request #18 from qtheuret/qtheuret-patch-1
[FIX] Fix KeyError when a kwargs key is not defined
Latest commit 8d1e10a Sep 2, 2018
Type Name Latest commit message Commit time
Failed to load latest commit information.
wallabag_api [FIX] Fix KeyError when a kwargs key is not defined Sep 2, 2018
.gitignore gitignore Mar 20, 2017
LICENSE Initial commit Dec 10, 2014
MANIFEST.in first shoot Dec 10, 2014
README.rst change repo Feb 19, 2018
setup.py fix #8 + upd API May 27, 2018
wallabag.png wallabag post Apr 22, 2016
wallabag_api_key.png create api client Apr 22, 2016


Python version supported License

Wallabag API

Python API for Wallabag v2.2.3

Requirements :

  • aiohttp


to get the project, from your virtualenv, do :

git clone https://github.com/push-things/wallabag_api/


pip install wallabag_api

Creating a post :

  1. request the token, if you don't have it yet
  2. create the post
#!/usr/bin/env python

import aiohttp
import asyncio

from wallabag_api.wallabag import Wallabag
# settings
my_host = 'http://localhost:8080'

async def main(loop):

    params = {'username': 'foxmask',
              'password': 'mypass',
              'client_id': 'myid',
              'client_secret': 'mysecret',
              'extension': 'pdf'}

    # get a new token
    token = await Wallabag.get_token(host=my_host, **params)

    # initializing
    async with aiohttp.ClientSession(loop=loop) as session:
        wall = Wallabag(host=my_host,

        url = 'https://foxmask.trigger-happy.eu'
        title = 'foxmask\'s  blog'

        await wall.post_entries(url, title, '', 0, 0)

        url = 'https://trigger-happy.eu'
        title = 'Project TrigerHappy'

        await wall.post_entries(url, title, '', 0, 0)

        # get all the articles
        my_wallabag = await wall.get_entries()

        all_article = my_wallabag['_embedded']['items']

        for article in all_article:
            print(article['id'], article['title'])

        # get the version of wallabag
        version = await wall.version
        print(f"version {version}")

        # export one article into PDF
        my_wallabag = await wall.get_entry_export(entry=1)
        with open("foobar.pdf", "wb") as f:

if __name__ == '__main__':
    loop = asyncio.get_event_loop()

this will give you something like this :


Testing :

Install Wallabag V2 on your own host like explain here http://doc.wallabag.org/en/v2/user/installation.html

Then run the development version (with make run)

Then create a client API like explain here http://doc.wallabag.org/en/v2/developer/api.html

this will give you something like this


Then replace the client_id / client_secret / login / pass to wallabag_test.py and run

python wallabag_test.py