Upgraded to support Appwrite 0.8

Author: eldadfux

.travis.yml

@@ -13,4 +13,4 @@ jobs:
         username: "__token__"
         password: $PYPI_TOKEN
         on:
-          tags: true
+          tags: true

README.md

@@ -1,9 +1,11 @@
 # Appwrite Python SDK
 
-![License](https://img.shields.io/github/license/appwrite/sdk-for-python.svg?v=1)
-![Version](https://img.shields.io/badge/api%20version-0.7.0-blue.svg?v=1)
+![License](https://img.shields.io/github/license/appwrite/sdk-for-python.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-0.8.0-blue.svg?style=flat-square)
+[![Twitter Account](https://img.shields.io/twitter/follow/appwrite_io?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite_io)
+[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
 
-**This SDK is compatible with Appwrite server version 0.7.0. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-python/releases).**
+**This SDK is compatible with Appwrite server version 0.8.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-python/releases).**
 
 Appwrite is an open-source backend as a service server that abstract and simplify complex and repetitive development tasks behind a very simple to use REST API. Appwrite aims to help you develop your apps faster and in a more secure way.
                         Use the Python SDK to integrate your app with the Appwrite server to easily start interacting with all of Appwrite backend APIs and tools.
@@ -19,6 +21,73 @@ To install via [PyPI](https://pypi.org/):
 pip install appwrite
 ```
 
+
+## Getting Started
+
+### Init your SDK
+Initialize your SDK code with your project ID which can be found in your project settings page and your new API secret Key from project's API keys section.
+
+```python
+from appwrite.client import Client
+from appwrite.services.users import Users
+
+client = Client()
+
+(client
+  .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+  .set_project('5df5acd0d48c2') # Your project ID
+  .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
+  .set_self_signed() # Use only on dev mode with a self-signed SSL cert
+)
+```
+
+### Make Your First Request
+Once your SDK object is set, create any of the Appwrite service objects and choose any request to send. Full documentation for any service method you would like to use can be found in your SDK documentation or in the API References section.
+
+```python
+users = Users(client)
+
+result = users.create('[email protected]', 'password')
+```
+
+### Full Example
+```python
+from appwrite.client import Client
+from appwrite.services.users import Users
+
+client = Client()
+
+(client
+  .set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
+  .set_project('5df5acd0d48c2') # Your project ID
+  .set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
+  .set_self_signed() # Use only on dev mode with a self-signed SSL cert
+)
+
+users = Users(client)
+
+result = users.create('[email protected]', 'password')
+```
+
+### Error Handling
+The Appwrite Python SDK raises `AppwriteException` object with `message`, `code` and `response` properties. You can handle any errors by catching `AppwriteException` and present the `message` to the user or handle it yourself based on the provided error information. Below is an example.
+
+```python
+users = Users(client)
+try:
+  result = users.create('[email protected]', 'password')
+except AppwriteException as e:
+  print(e.message)
+```
+
+### Learn more
+You can use followng resources to learn more and get help
+- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
+- 📜 [Appwrite Docs](https://appwrite.io/docs)
+- 💬 [Discord Community](https://appwrite.io/discord)
+- 🚂 [Appwrite Python Playground](https://github.com/appwrite/playground-for-python)
+
+
 ## Contribution
 
 This library is auto-generated by Appwrite custom [SDK Generator](https://github.com/appwrite/sdk-generator). To learn more about how you can help us improve this SDK, please check the [contribution guide](https://github.com/appwrite/sdk-generator/blob/master/CONTRIBUTING.md) before sending a pull-request.

appwrite/client.py

@@ -1,13 +1,15 @@
 import io
 import requests
+from .exception import AppwriteException
 
 class Client:
     def __init__(self):
         self._self_signed = False
         self._endpoint = 'https://appwrite.io/v1'
         self._global_headers = {
             'content-type': '',
-            'x-sdk-version': 'appwrite:python:0.1.0',
+            'x-sdk-version': 'appwrite:python:0.2.0',
+            'X-Appwrite-Response-Format' : '0.8.0',
         }
 
     def set_self_signed(self, status=True):
@@ -34,6 +36,12 @@ def set_key(self, value):
         self._global_headers['x-appwrite-key'] = value.lower()
         return self
 
+    def set_j_w_t(self, value):
+        """Your secret JSON Web Token"""
+
+        self._global_headers['x-appwrite-jwt'] = value.lower()
+        return self
+
     def set_locale(self, value):
         self._global_headers['x-appwrite-locale'] = value.lower()
         return self
@@ -66,26 +74,36 @@ def call(self, method, path='', headers=None, params=None):
                 if isinstance(data[key], io.BufferedIOBase):
                     files[key] = data[key]
                     del data[key]
-
-        response = requests.request(  # call method dynamically https://stackoverflow.com/a/4246075/2299554
-            method=method,
-            url=self._endpoint + path,
-            params=self.flatten(params),
-            data=self.flatten(data),
-            json=json,
-            files=files,
-            headers=headers,
-            verify=self._self_signed,
-        )
-
-        response.raise_for_status()
-
-        content_type = response.headers['Content-Type']
-
-        if content_type.startswith('application/json'):
-            return response.json()
-
-        return response._content
+        response = None
+        try:
+            response = requests.request(  # call method dynamically https://stackoverflow.com/a/4246075/2299554
+                method=method,
+                url=self._endpoint + path,
+                params=self.flatten(params),
+                data=self.flatten(data),
+                json=json,
+                files=files,
+                headers=headers,
+                verify=self._self_signed,
+            )
+
+            response.raise_for_status()
+
+            content_type = response.headers['Content-Type']
+
+            if content_type.startswith('application/json'):
+                return response.json()
+
+            return response._content
+        except Exception as e:
+            if response != None:
+                content_type = response.headers['Content-Type']
+                if content_type.startswith('application/json'):
+                    raise AppwriteException(response.json()['message'], response.status_code, response.json())
+                else:
+                    raise AppwriteException(response.text, response.status_code)
+            else:
+                raise AppwriteException(e)
 
     def flatten(self, data, prefix=''):
         output = {}

appwrite/exception.py

@@ -0,0 +1,6 @@
+class AppwriteException(Exception):
+    def __init__(self, message, code = 0, response = None):
+        self.message = message
+        self.code = code
+        self.response = response
+        super().__init__(self.message)

appwrite/services/account.py

@@ -0,0 +1,173 @@
+from ..service import Service
+
+
+class Account(Service):
+
+    def __init__(self, client):
+        super(Account, self).__init__(client)
+
+    def get(self):
+        """Get Account"""
+
+        params = {}
+        path = '/account'
+
+        return self.client.call('get', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def delete(self):
+        """Delete Account"""
+
+        params = {}
+        path = '/account'
+
+        return self.client.call('delete', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def update_email(self, email, password):
+        """Update Account Email"""
+
+        params = {}
+        path = '/account/email'
+        params['email'] = email
+        params['password'] = password
+
+        return self.client.call('patch', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def get_logs(self):
+        """Get Account Logs"""
+
+        params = {}
+        path = '/account/logs'
+
+        return self.client.call('get', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def update_name(self, name):
+        """Update Account Name"""
+
+        params = {}
+        path = '/account/name'
+        params['name'] = name
+
+        return self.client.call('patch', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def update_password(self, password, old_password=''):
+        """Update Account Password"""
+
+        params = {}
+        path = '/account/password'
+        params['password'] = password
+        params['oldPassword'] = old_password
+
+        return self.client.call('patch', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def get_prefs(self):
+        """Get Account Preferences"""
+
+        params = {}
+        path = '/account/prefs'
+
+        return self.client.call('get', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def update_prefs(self, prefs):
+        """Update Account Preferences"""
+
+        params = {}
+        path = '/account/prefs'
+        params['prefs'] = prefs
+
+        return self.client.call('patch', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def create_recovery(self, email, url):
+        """Create Password Recovery"""
+
+        params = {}
+        path = '/account/recovery'
+        params['email'] = email
+        params['url'] = url
+
+        return self.client.call('post', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def update_recovery(self, user_id, secret, password, password_again):
+        """Complete Password Recovery"""
+
+        params = {}
+        path = '/account/recovery'
+        params['userId'] = user_id
+        params['secret'] = secret
+        params['password'] = password
+        params['passwordAgain'] = password_again
+
+        return self.client.call('put', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def get_sessions(self):
+        """Get Account Sessions"""
+
+        params = {}
+        path = '/account/sessions'
+
+        return self.client.call('get', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def delete_sessions(self):
+        """Delete All Account Sessions"""
+
+        params = {}
+        path = '/account/sessions'
+
+        return self.client.call('delete', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def delete_session(self, session_id):
+        """Delete Account Session"""
+
+        params = {}
+        path = '/account/sessions/{sessionId}'
+        path = path.replace('{sessionId}', session_id)                
+
+        return self.client.call('delete', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def create_verification(self, url):
+        """Create Email Verification"""
+
+        params = {}
+        path = '/account/verification'
+        params['url'] = url
+
+        return self.client.call('post', path, {
+            'content-type': 'application/json',
+        }, params)
+
+    def update_verification(self, user_id, secret):
+        """Complete Email Verification"""
+
+        params = {}
+        path = '/account/verification'
+        params['userId'] = user_id
+        params['secret'] = secret
+
+        return self.client.call('put', path, {
+            'content-type': 'application/json',
+        }, params)

appwrite/services/database.py

@@ -45,7 +45,7 @@ def get_collection(self, collection_id):
             'content-type': 'application/json',
         }, params)
 
-    def update_collection(self, collection_id, name, read, write, rules=[]):
+    def update_collection(self, collection_id, name, read=[], write=[], rules=[]):
         """Update Collection"""
 
         params = {}
@@ -89,7 +89,7 @@ def list_documents(self, collection_id, filters=[], limit=25, offset=0, order_fi
             'content-type': 'application/json',
         }, params)
 
-    def create_document(self, collection_id, data, read, write, parent_document='', parent_property='', parent_property_type='assign'):
+    def create_document(self, collection_id, data, read=[], write=[], parent_document='', parent_property='', parent_property_type='assign'):
         """Create Document"""
 
         params = {}
@@ -118,7 +118,7 @@ def get_document(self, collection_id, document_id):
             'content-type': 'application/json',
         }, params)
 
-    def update_document(self, collection_id, document_id, data, read, write):
+    def update_document(self, collection_id, document_id, data, read=[], write=[]):
         """Update Document"""
 
         params = {}