82 lines
1.6 KiB
ReStructuredText
82 lines
1.6 KiB
ReStructuredText
============
|
||
Wallabag API
|
||
============
|
||
|
||
Python API for Wallabag v2
|
||
|
||
Requirements :
|
||
==============
|
||
|
||
* requests
|
||
|
||
Installation:
|
||
=============
|
||
|
||
to get the project, from your virtualenv, do :
|
||
|
||
.. code:: python
|
||
|
||
git clone https://github.com/push-things/wallabag-api/
|
||
|
||
|
||
or
|
||
|
||
.. code:: python
|
||
|
||
pip install wallabag_api
|
||
|
||
|
||
|
||
Creating a post :
|
||
=================
|
||
|
||
1) request the token, if you don't have it yet
|
||
2) create the post
|
||
|
||
.. code:: python
|
||
|
||
from wallabag_api.wallabag import Wallabag
|
||
# settings
|
||
params = {'username': 'foxmask',
|
||
'password': 'mypass',
|
||
'client_id': 'myid',
|
||
'client_secret': 'mysecret'}
|
||
my_host = 'http://localhost:8080'
|
||
# get token
|
||
token = Wallabag.get_token(host=my_host, **params)
|
||
|
||
# create a post
|
||
wall = Wallabag(host=my_host, client_secret='mysecret', client_id='myid', token=token)
|
||
|
||
my_url = 'https://blog.trigger-happy.eu'
|
||
my_title = 'Trigger Happy blog'
|
||
my_tags = ['python', 'wallabag']
|
||
|
||
wall.post_entries(url=my_url, title=my_title, tags=my_tags)
|
||
|
||
|
||
this will give you something like this :
|
||
|
||
.. image:: https://github.com/push-things/wallabag_api/blob/master/wallabag.png
|
||
|
||
|
||
|
||
Testing :
|
||
=========
|
||
|
||
Install Wallabag V2 on your own host like explain here http://doc.wallabag.org/en/v2/user/installation.html
|
||
|
||
Then create a client API like explain here http://doc.wallabag.org/en/v2/developer/api.html
|
||
|
||
this will give you somthing like this
|
||
|
||
.. image:: https://github.com/push-things/wallabag_api/blob/master/wallabag_api_key.png
|
||
|
||
Then replace the client_id / client_secret / login / pass to wallabag_test.py and run
|
||
|
||
.. code:: python
|
||
|
||
python wallabag_test.py
|
||
|
||
|