upd doc and setup

README.rst

@@ -3,11 +3,6 @@
     :alt: Python version supported
 
 
-.. image:: http://img.shields.io/badge/python-3.5-orange.svg
-    :target: https://pypi.python.org/pypi/django-th/
-    :alt: Python version supported
-
-
 .. image:: http://img.shields.io/badge/license-BSD-blue.svg
     :target: https://pypi.python.org/pypi/django-th/
     :alt: License
@@ -22,7 +17,7 @@ Python API for Wallabag v2.2.3
 Requirements :
 ==============
 
-* requests  2.13.0
+* aiohttp
 
 
 Installation:
@@ -51,27 +46,66 @@ Creating a post :
 
 .. code:: python
 
+    #!/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'}
+                  'client_secret': 'mysecret',
-    my_host = 'http://localhost:8080'
+                  'extension': 'pdf'}
-    # get token
-    token = Wallabag.get_token(host=my_host, **params)
 
-    # create a post
+        # 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,
-                    client_secret='mysecret',
+                            client_secret=params.get('client_secret'),
-                    client_id='myid',
+                            client_id=params.get('client_id'),
-                    token=token)
+                            token=token,
+                            extension=params['extension'],
+                            aio_sess=session)
 
-    my_url = 'https://blog.trigger-happy.eu'
+            url = 'https://foxmask.trigger-happy.eu'
-    my_title = 'Trigger Happy blog'
+            title = 'foxmask\'s  blog'
-    my_tags = ['python', 'wallabag']
 
-    wall.post_entries(url=my_url, title=my_title, tags=my_tags)
+            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:
+                f.write(my_wallabag)
+
+    if __name__ == '__main__':
+        loop = asyncio.get_event_loop()
+        loop.run_until_complete(main(loop))
 
 
 this will give you something like this :
@@ -79,42 +113,6 @@ this will give you something like this :
 .. image:: https://github.com/foxmask/wallabag_api/blob/master/wallabag.png
 
 
-3) get all the entries
-
-.. code:: python
-
-    # get all the entries
-    wall = wall.get_entries()
-
-    all_article = wall['_embedded']['items']
-
-    for article in all_article:
-        print(article['title'])
-        print(article['content'])
-        print("******")
-
-4) version of wallabag
-
-.. code:: python
-
-    # get the version of your wallabag instance
-    print("version {}".format(wall.version))
-
-5) to get the article in PDF
-
-.. code:: python
-
-    # to get the article in PDF for example,
-    wall = Wallabag(host=my_host,
-                    client_secret='mysecret',
-                    client_id='myid',
-                    token=token,
-                    extension='pdf')
-    article = wall.get_entry_export(entry=1)
-    with open("my_file.pdf", "wb") as f:
-        f.write(article)
-
-
 Testing :
 =========
 
@@ -124,7 +122,7 @@ 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 somthing like this
+this will give you something like this
 
 .. image:: https://github.com/foxmask/wallabag_api/blob/master/wallabag_api_key.png
 

setup.py

@@ -1,14 +1,15 @@
 from setuptools import setup, find_packages
 from wallabag_api import __version__ as version
 
+desc = 'Wallabag API to add every pages you want to your Wallabag account'
 install_requires = [
-    'requests-2.13.0',
+    'aiohttp==2.2.5',
 ]
 
 setup(
     name='wallabag_api',
     version=version,
-    description='Wallabag API to add every pages you want to your Wallabag account',
+    description=desc,
     author='FoxMaSk',
     author_email='foxmask@trigger-happy.eu',
     url='https://github.com/foxmask/wallabag_api',
@@ -21,7 +22,6 @@ setup(
         'License :: OSI Approved :: BSD License',
         'Operating System :: OS Independent',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 3.5',
         'Programming Language :: Python :: 3.6',
         'Topic :: Internet',
         'Topic :: Communications',

wallabag_api/__init__.py

@@ -1,2 +1,2 @@
-VERSION = (1, 3, 0)  # PEP 386
+VERSION = (1, 4, 0)  # PEP 386
 __version__ = ".".join([str(x) for x in VERSION])

wallabag_api/wallabag.py

@@ -3,12 +3,9 @@ import logging
 import aiohttp
 from aiohttp.http_exceptions import HttpProcessingError
 from aiohttp.client_exceptions import ClientResponseError
-# from aiohttp import HTTPError
-
 
 __author__ = 'foxmask'
 
-
 logging.basicConfig(format='%(message)s', level=logging.INFO)
 
 __all__ = ['Wallabag']
@@ -47,7 +44,7 @@ class Wallabag(object):
         :param client_secret client secret
         :param extension: xml|json|txt|csv|pdf|epub|mobi|html
         :param user_agent
-            :param aio_session aiohttp session
+        :param aio_sess aiohttp session
         """
         self.host = host
         self.client_id = client_id
@@ -57,14 +54,8 @@ class Wallabag(object):
         self.user_agent = user_agent
         self.aio_sess = aio_sess
         if self.format not in self.EXTENTIONS:
-            raise ValueError("format invalid {0} should be one of {1}".format(self.format, self.EXTENTIONS))
+            raise ValueError("format invalid {0} should be one of {1}".format(
-
+                self.format, self.EXTENTIONS))
-    def get_host(self):
-        """
-            get the host from which to get API
-            :return host
-        """
-        return self.host
 
     async def query(self, path, method='get', **params):
         """
@@ -94,7 +85,7 @@ class Wallabag(object):
                 if resp.content_type.startswith('application/pdf') or \
                         resp.content_type.startswith('application/epub'):
                     return await resp.read()
-                else:
+
                 return await self.handle_json_response(resp)
         else:
             raise ValueError('method expected: get, post, patch, delete, put')
@@ -115,7 +106,7 @@ class Wallabag(object):
         except ClientResponseError as e:
             # sometimes json_data does not return any json() without
             # any error. This is due to the grabbing URL which "rejects"
-            # the URL
+            # the URL
             logging.error("Wallabag: aiohttp error {code} {message}"
                           .format(code=e.code, message=e.message))
         return await json_data
@@ -123,12 +114,12 @@ class Wallabag(object):
     @staticmethod
     def __get_attr(what, type_attr, value_attr, **kwargs):
         """
-
+        get the value of a parm
-        :param what:
+        :param what: string parm
-        :param type_attr:
+        :param type_attr: type of parm
         :param value_attr:
         :param kwargs:
-        :return:
+        :return: value of the parm
         """
         value = int(kwargs[what]) if type_attr == 'int' else kwargs[what]
         if what in kwargs and value in value_attr:
@@ -137,7 +128,6 @@ class Wallabag(object):
     # ENTRIES
     async def get_entries(self, **kwargs):
         """
-
         GET /api/entries.{_format}
 
         Retrieve all entries. It could be filtered by many options.
@@ -199,7 +189,6 @@ class Wallabag(object):
 
     async def post_entries(self, url, title='', tags='', starred=0, archive=0):
         """
-
         POST /api/entries.{_format}
 
         Create an entry
@@ -220,7 +209,6 @@ class Wallabag(object):
 
     async def get_entry(self, entry):
         """
-
         GET /api/entries/{entry}.{_format}
 
         Retrieve a single entry
@@ -235,7 +223,6 @@ class Wallabag(object):
 
     async def patch_entries(self, entry, **kwargs):
         """
-
         PATCH /api/entries/{entry}.{_format}
 
         Change several properties of an entry
@@ -286,7 +273,6 @@ class Wallabag(object):
 
     async def get_entry_export(self, entry):
         """
-
         GET /api/entries/{entry}/export.{_format}
 
         Retrieve a single entry as a predefined format.
@@ -301,11 +287,11 @@ class Wallabag(object):
 
     async def patch_entry_reload(self, entry):
         """
-
         PATCH /api/entries/{entry}/reload.{_format}
 
-            Reload an entry. An empty response with HTTP Status 304 will be send if we weren't able to update
+        Reload an entry. An empty response with HTTP Status 304 will be send
-            the content (because it hasn't changed or we got an error).
+        if we weren't able to update the content (because it hasn't changed
+        or we got an error).
 
         :param entry: \w+ an integer The Entry ID
         :return data related to the ext
@@ -317,7 +303,6 @@ class Wallabag(object):
 
     async def delete_entries(self, entry):
         """
-
         DELETE /api/entries/{entry}.{_format}
 
         Delete permanently an entry
@@ -333,14 +318,14 @@ class Wallabag(object):
 
     async def entries_exists(self, url, urls=''):
         """
-
         GET /api/entries/exists.{_format}
 
         Check if an entry exist by url.
 
         :param url 	string 	true 	An url 	Url to check if it exists
-            :param urls string 	false 	An array of urls (?urls[]=http...&urls[]=http...)
+        :param urls string 	false 	An array of urls
-            Urls (as an array) to check if it exists
+        (?urls[]=http...&urls[]=http...) Urls (as an array)
+        to check if it exists
 
         :return result
         """
@@ -354,7 +339,6 @@ class Wallabag(object):
 
     async def get_entry_tags(self, entry):
         """
-
         GET /api/entries/{entry}/tags.{_format}
 
         Retrieve all tags for an entry
@@ -369,7 +353,6 @@ class Wallabag(object):
 
     async def post_entry_tags(self, entry, tags):
         """
-
         POST /api/entries/{entry}/tags.{_format}
 
         Add one or more tags to an entry
@@ -387,7 +370,6 @@ class Wallabag(object):
 
     async def delete_entry_tag(self, entry, tag):
         """
-
         DELETE /api/entries/{entry}/tags/{tag}.{_format}
 
         Permanently remove one tag for an entry
@@ -401,9 +383,8 @@ class Wallabag(object):
             entry=entry, tag=tag, ext=self.format)
         return await self.query(url, "delete", **params)
 
-    async def get_tags(self, session):
+    async def get_tags(self):
         """
-
         GET /api/tags.{_format}
 
         Retrieve all tags
@@ -416,7 +397,6 @@ class Wallabag(object):
 
     async def delete_tag(self, tag):
         """
-
         DELETE /api/tags/{tag}.{_format}
 
         Permanently remove one tag from every entry
@@ -430,7 +410,6 @@ class Wallabag(object):
 
     async def delete_tag_label(self, tag):
         """
-
         DELETE /api/tag/label.{_format}
 
         Permanently remove one tag from every entry.
@@ -438,7 +417,6 @@ class Wallabag(object):
         :param tag: string The Tag
         :return data related to the ext
         """
-        # @TODO check if that method is well documented as its the same as delete_tags !
         path = '/api/tag/label.{ext}'.format(ext=self.format)
         params = {'access_token': self.token,
                   'tag': tag}
@@ -446,7 +424,6 @@ class Wallabag(object):
 
     async def delete_tags_label(self, tags):
         """
-
         DELETE /api/tags/label.{_format}
 
         Permanently remove some tags from every entry.
@@ -454,7 +431,6 @@ class Wallabag(object):
         :param tags: string tags as strings (comma splitted)
         :return data related to the ext
         """
-        # @TODO check if that method is well documented as its the same as delete_tags !
         path = '/api/tag/label.{ext}'.format(ext=self.format)
         params = {'access_token': self.token,
                   'tags': tags}
@@ -463,7 +439,6 @@ class Wallabag(object):
     # ANNOTATIONS
     async def delete_annotations(self, annotation):
         """
-
         DELETE /api/annotations/{annotation}.{_format}
 
         Removes an annotation.
@@ -480,7 +455,6 @@ class Wallabag(object):
 
     async def put_annotations(self, annotation):
         """
-
         PUT /api/annotations/{annotation}.{_format}
 
         Updates an annotation.
@@ -497,7 +471,6 @@ class Wallabag(object):
 
     async def get_annotations(self, entry):
         """
-
         GET /api/annotations/{entry}.{_format}
 
         Retrieve annotations for an entry
@@ -514,7 +487,6 @@ class Wallabag(object):
 
     async def post_annotations(self, entry, **kwargs):
         """
-
         POST /api/annotations/{entry}.{_format}
 
         Creates a new annotation.
@@ -542,7 +514,6 @@ class Wallabag(object):
     @property
     async def version(self):
         """
-
         GET /api/version.{_format}
 
         Retrieve version number
@@ -556,6 +527,9 @@ class Wallabag(object):
     @classmethod
     async def get_token(cls, host, **params):
         """
+        POST /oauth/v2/token
+
+        Get a new token
 
         :param host: host of the service
         :param params: will contain :
@@ -574,4 +548,3 @@ class Wallabag(object):
             async with sess.post(host + path, data=params) as resp:
                 data = await cls.handle_json_response(resp)
                 return data.get("access_token")
-