Rename QencodeApiClient to Client. Make available via qencode.Client

Class instances should start with capital letters and always the pure
object being classified if possible (for code completion, api interlinking,
type annotations, etc)

Author: tony

README.md

@@ -33,7 +33,7 @@ poetry install
 ```python
 import qencode
 
-client = qencode.client(API_KEY)
+client = qencode.Client(api_key=API_KEY)
 client.create()
 
 task = client.create_task()

docs/quickstart.md

@@ -27,7 +27,7 @@ poetry install
 ```python
 import qencode
 
-client = qencode.client(API_KEY)
+client = qencode.Client(api_key=API_KEY)
 client.create()
 
 task = client.create_task()

docs/usage.md

@@ -15,7 +15,7 @@ VIDEO_URL = 'your source url'
 
 
 def start_encode():
-    client = qencode.client(API_KEY)
+    client = qencode.Client(api_key=API_KEY)
     client.create()
     if client.error:
         print 'encoder error:', client.error, client.message
@@ -102,7 +102,7 @@ def start_encode():
     :param api_version: int. not required. default 'v1'
     :return: client object
     """
-    client = qencode.client(API_KEY)
+    client = qencode.Client(api_key=API_KEY)
     client.create()
     if client.error:
         print('encoder error:', client.error, client.message)

qencode/__init__.py

@@ -1,3 +1,4 @@
+from .client import Client
 from .custom_params import (
     CustomTranscodingParams,
     Destination,
@@ -12,7 +13,7 @@
 def client(api_key, api_url=None, version=None, **kwargs):
     from client import QencodeApiClient
 
-    return QencodeApiClient(api_key, api_url=api_url, version=version, **kwargs)
+    return Client(api_key, api_url=api_url, version=version, **kwargs)
 
 
 __version__ = "1.0"

qencode/client.py

@@ -3,7 +3,7 @@
 from task import Task
 
 
-class QencodeApiClient(object):
+class Client(object):
     def __init__(self, api_key, api_url=None, version=None):
         self.api_key = api_key
         self.api_url = api_url if api_url else 'https://api.qencode.com/'

sample-code/start_custom_hls.py

@@ -52,7 +52,7 @@ def start_encode():
     :return: task object
     """
 
-    client = qencode.client(API_KEY)
+    client = qencode.Client(api_key=API_KEY)
     if client.error:
         raise QencodeClientException(client.message)
 

sample-code/start_custom_mp4.py

@@ -46,7 +46,7 @@ def start_encode():
     :return: task object
     """
 
-    client = qencode.client(API_KEY)
+    client = qencode.Client(api_key=API_KEY)
     if client.error:
         raise QencodeClientException(client.message)
 

sample-code/start_custom_with_dict.py

@@ -40,7 +40,7 @@ def start_encode():
     :return: task object
     """
 
-    client = qencode.client(API_KEY)
+    client = qencode.Client(api_key=API_KEY)
     if client.error:
         raise QencodeClientException(client.message)
 

sample-code/start_custom_with_file.py

@@ -42,9 +42,9 @@ def start_encode():
     :param api_url: string. not required
     :param api_version: int. not required. default 'v1'
     :return: task object
-  """
+    """
 
-    client = qencode.client(API_KEY)
+    client = qencode.Client(api_key=API_KEY)
     if client.error:
         raise QencodeClientException(client.message)
 

sample-code/start_custom_with_json.py

@@ -40,7 +40,7 @@ def start_encode():
     :return: task object
     """
 
-    client = qencode.client(API_KEY)
+    client = qencode.Client(api_key=API_KEY)
     if client.error:
         raise QencodeClientException(client.message)