Simplify client class

Author: fguillot

.travis.yml

@@ -13,9 +13,9 @@ matrix:
       dist: xenial
       sudo: true
 
-install:
-  - pip install -r test-requirements.txt
+before_install:
+  - pip install flake8
 
 script:
   - python setup.py test
-  - flake8 --ignore E125,E123,E129 --max-line-length 120 --exclude kanboard/__init__.py kanboard/ tests/
+  - flake8 --max-line-length 120 *.py

README.rst

@@ -18,25 +18,28 @@ Installation
     pip install kanboard
 
 
-This library is compatible with Python 3.5, 3.6, and 3.7.
+This library is compatible with Python >= 3.5.
+
+Note: **Support for Python 2.7 has been dropped from version 1.1.0.**
 
 Examples
 ========
 
-Methods and arguments are the same as the JSON-RPC procedures described in the `official documentation <https://docs.kanboard.org/en/latest/api/index.html>`_.
+Methods and arguments are the same as the JSON-RPC procedures described in the
+`official documentation <https://docs.kanboard.org/en/latest/api/index.html>`_.
 
-Python methods are dynamically mapped to the API procedures. You must use named arguments.
+Python methods are dynamically mapped to the API procedures. **You must use named arguments.**
 
-By default, the calls are made synchronously, meaning that they will block the program until completed.
+By default, calls are made synchronously, meaning that they will block the program until completed.
 
-Create a new team project
--------------------------
+Creating a new team project
+---------------------------
 
 .. code-block:: python
 
-    from kanboard import Kanboard
+    import kanboard
 
-    kb = Kanboard('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
+    kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
     project_id = kb.create_project(name='My project')
 
 
@@ -45,34 +48,37 @@ Authenticate as user
 
 .. code-block:: python
 
-    from kanboard import Kanboard
+    import kanboard
 
-    kb = Kanboard('http://localhost/jsonrpc.php', 'admin', 'admin')
+    kb = kanboard.Client('http://localhost/jsonrpc.php', 'admin', 'secret')
     kb.get_my_projects()
 
 Create a new task
 -----------------
 
 .. code-block:: python
 
-    from kanboard import Kanboard
+    import kanboard
 
-    kb = Kanboard('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
+    kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
     project_id = kb.create_project(name='My project')
     task_id = kb.create_task(project_id=project_id, title='My task title')
 
 Asynchronous I/O
 ================
 
-The client also exposes async/await style method calls. Similarly to the synchronous calls (see above), the method names are mapped to the API methods.
-To invoke an asynchronous call, the method name must be appended with `_async`: for example, a synchronous call to `create_project` can be made asynchronous by calling `create_project_async` instead.
+The client also exposes async/await style method calls. Similarly to the synchronous calls (see above),
+the method names are mapped to the API methods.
+
+To invoke an asynchronous call, the method name must be appended with ``_async``. For example, a synchronous call
+to ``create_project`` can be made asynchronous by calling ``create_project_async`` instead.
 
 .. code-block:: python
 
     import asyncio
-    from kanboard import Kanboard
+    import kanboard
 
-    kb = Kanboard('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
+    kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
 
     loop = asyncio.get_event_loop()
     project_id = loop.run_until_complete(kb.create_project_async(name='My project'))
@@ -81,13 +87,15 @@ To invoke an asynchronous call, the method name must be appended with `_async`:
 .. code-block:: python
 
     import asyncio
-    from kanboard import Kanboard
+    import kanboard
 
     async def call_within_function()
-      kb = Kanboard('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
-      return await kb.create_project_async(name='My project')
+        kb = kanboard.Client('http://localhost/jsonrpc.php', 'jsonrpc', 'your_api_token')
+        return await kb.create_project_async(name='My project')
 
     loop = asyncio.get_event_loop()
     project_id = loop.run_until_complete(call_within_function())
 
-See the `official API documentation <https://docs.kanboard.org/en/latest/api/index.html>`_ for the complete list of methods and arguments.
+
+See the `official API documentation <https://docs.kanboard.org/en/latest/api/index.html>`_ for the complete list of
+methods and arguments.

kanboard/client.py kanboard.pykanboard/client.py renamed to kanboard.py

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2016-2018 Frederic Guillot
+# Copyright (c) 2016-2019 Frederic Guillot
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -24,26 +24,28 @@
 import base64
 import functools
 import asyncio
-
-from kanboard import exceptions
 from urllib import request as http
 
 
 DEFAULT_AUTH_HEADER = 'Authorization'
 ASYNC_FUNCNAME_MARKER = "_async"
 
 
-class Kanboard(object):
+class ClientError(Exception):
+    pass
+
+
+class Client:
     """
     Kanboard API client
 
     Example:
 
-        from kanboard import Kanboard
+        from kanboard import Client
 
-        kb = Kanboard(url="http://localhost/jsonrpc.php",
-                      username="jsonrpc",
-                      password="your_api_token")
+        kb = Client(url="http://localhost/jsonrpc.php",
+                    username="jsonrpc",
+                    password="your_api_token")
 
         project_id = kb.create_project(name="My project")
 
@@ -75,7 +77,7 @@ def __init__(self,
         self._event_loop = loop
 
     def __getattr__(self, name):
-        if(self.is_async_method_name(name)):
+        if self.is_async_method_name(name):
             async def function(*args, **kwargs):
                 return await self._event_loop.run_in_executor(
                     None,
@@ -108,7 +110,7 @@ def _parse_response(response):
 
             if 'error' in body:
                 message = body.get('error').get('message')
-                raise exceptions.KanboardClientException(message)
+                raise ClientError(message)
 
             return body.get('result')
         except ValueError:
@@ -124,7 +126,7 @@ def _do_request(self, headers, body):
             else:
                 response = http.urlopen(request).read()
         except Exception as e:
-            raise exceptions.KanboardClientException(str(e))
+            raise ClientError(str(e))
         return self._parse_response(response)
 
     def execute(self, method, **kwargs):
@@ -139,7 +141,6 @@ def execute(self, method, **kwargs):
             Procedure result
 
         Raises:
-            urllib2.HTTPError: Any HTTP error (Python 2)
             urllib.error.HTTPError: Any HTTP error (Python 3)
         """
         payload = {

kanboard/__init__.py

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 #
-# Copyright (c) 2016-2018 Frederic Guillot
+# Copyright (c) 2016-2019 Frederic Guillot
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -20,16 +20,14 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-try:
-    from setuptools import setup
-except ImportError:
-    from distutils.core import setup
+from setuptools import setup
 
 
 def readme():
     with open('README.rst') as f:
         return f.read()
 
+
 setup(
     name='kanboard',
     version='1.1.0',
@@ -40,7 +38,8 @@ def readme():
     author='Frederic Guillot',
     author_email='fred@kanboard.net',
     license='MIT',
-    packages=['kanboard'],
+    py_modules=['miniflux'],
+    test_suite='test_kanboard',
     classifiers=[
         'Intended Audience :: Developers',
         'Intended Audience :: Information Technology',

kanboard/exceptions.py

@@ -25,15 +25,14 @@
 import types
 import warnings
 
-from kanboard import client
-from kanboard import exceptions
+import kanboard
 
 
-class TestKanboard(unittest.TestCase):
+class TestClient(unittest.TestCase):
 
     def setUp(self):
         self.url = 'some api url'
-        self.client = client.Kanboard(self.url, 'username', 'password')
+        self.client = kanboard.Client(self.url, 'username', 'password')
         self.request, self.urlopen = self._create_mocks()
 
     def ignore_warnings(test_func):
@@ -64,14 +63,14 @@ def test_custom_auth_header(self):
 
     def test_http_error(self):
         self.urlopen.side_effect = Exception()
-        with self.assertRaises(exceptions.KanboardClientException):
+        with self.assertRaises(kanboard.ClientError):
             self.client.remote_procedure()
 
     def test_application_error(self):
         body = b'{"jsonrpc": "2.0", "error": {"code": -32603, "message": "Internal error"}, "id": 123}'
         self.urlopen.return_value.read.return_value = body
 
-        with self.assertRaises(exceptions.KanboardClientException, msg='Internal error'):
+        with self.assertRaises(kanboard.ClientError, msg='Internal error'):
             self.client.remote_procedure()
 
     def test_async_method_call_recognised(self):