Add support for custom user agent

README.rst

@@ -68,6 +68,18 @@ Create a new task
     project_id = kb.create_project(name='My project')
     task_id = kb.create_task(project_id=project_id, title='My task title')
 
+Use a personalized user agent
+-----------------------------
+
+.. code-block:: python
+
+    import kanboard
+
+    kb = kanboard.Client(url='http://localhost/jsonrpc.php',
+                         username='admin',
+                         password='secret',
+                         user_agent='My Kanboard client')
+
 SSL connection and self-signed certificates
 ===========================================
 
@@ -86,7 +98,10 @@ Example with a custom certificate:
 
     import kanboard
 
-    kb = kanboard.Client('https://example.org/jsonrpc.php', 'admin', 'secret', cafile='/path/to/my/cert.pem')
+    kb = kanboard.Client(url='https://example.org/jsonrpc.php',
+                         username='admin',
+                         password='secret',
+                         cafile='/path/to/my/cert.pem')
     kb.get_my_projects()
 
 Example with a custom certificate and hostname mismatch:
@@ -108,7 +123,10 @@ Ignore invalid/expired certificates and hostname mismatches, which will make you
 
     import kanboard
 
-    kb = kanboard.Client('https://example.org/jsonrpc.php', 'admin', 'secret', insecure=True)
+    kb = kanboard.Client(url='https://example.org/jsonrpc.php',
+                         username='admin',
+                         password='secret',
+                         insecure=True)
     kb.get_my_projects()
 
 Asynchronous I/O

kanboard.py

@@ -61,6 +61,7 @@ def __init__(self,
                  cafile: Optional[str] = None,
                  insecure: bool = False,
                  ignore_hostname_verification: bool = False,
+                 user_agent: str = 'Kanboard Python API Client',
                  loop: Optional[asyncio.AbstractEventLoop] = None):
         """
         Constructor
@@ -73,6 +74,7 @@ def __init__(self,
             cafile: Path to a custom CA certificate
             insecure: Ignore SSL certificate errors and ignore hostname mismatches
             ignore_hostname_verification: Ignore SSL certificate hostname verification
+            user_agent: Use a personalized user agent
             loop: An asyncio event loop. Default: asyncio.get_event_loop()
         """
         self._url = url
@@ -81,6 +83,7 @@ def __init__(self,
         self._auth_header = auth_header
         self._cafile = cafile
         self._insecure = insecure
+        self._user_agent = user_agent
         self._ignore_hostname_verification = ignore_hostname_verification
 
         if not loop:
@@ -174,6 +177,7 @@ def execute(self, method: str, **kwargs):
         headers = {
             self._auth_header: auth_header_prefix + credentials.decode(),
             'Content-Type': 'application/json',
+            'User-Agent': self._user_agent,
         }
 
         return self._do_request(headers, payload)

setup.py

@@ -30,7 +30,7 @@ def readme():
 
 setup(
     name='kanboard',
-    version='1.1.4',
+    version='1.1.5',
     description='Client library for Kanboard',
     long_description=readme(),
     keywords='kanboard api client',