appwrite 25.0.0__tar.gz → 26.0.0__tar.gz

appwrite-26.0.0/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: appwrite
+Version: 26.0.0
+Summary: Appwrite is an open-source self-hosted backend server that abstracts and simplifies complex and repetitive development tasks behind a very simple REST API
+Home-page: https://appwrite.io/support
+Download-URL: https://github.com/appwrite/sdk-for-python/archive/26.0.0.tar.gz
+Author: Appwrite Team
+Author-email: Appwrite Team <team@appwrite.io>
+Maintainer: Appwrite Team
+Maintainer-email: Appwrite Team <team@appwrite.io>
+License: BSD-3-Clause
+Project-URL: Homepage, https://appwrite.io/support
+Project-URL: Repository, https://github.com/appwrite/sdk-for-python
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Environment :: Web Environment
+Classifier: Topic :: Software Development
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: pydantic<3,>=2
+Provides-Extra: test
+Requires-Dist: black==25.11.0; extra == "test"
+Requires-Dist: requests_mock==1.11.0; extra == "test"
+Dynamic: author
+Dynamic: download-url
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: maintainer
+Dynamic: requires-python
+
+# Appwrite Python SDK
+
+![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-2.5.0-blue.svg?style=flat-square)
+[![X Account](https://img.shields.io/badge/follow-%40appwrite-000000?logo=x&style=flat-square)](https://x.com/appwrite)
+[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
+
+**This SDK targets Appwrite server version 2.5.x as shipped on Appwrite Cloud.** Self-hosted releases can lag behind Cloud — if you run an older self-hosted build, use a matching older SDK from [previous releases](https://github.com/appwrite/sdk-for-python/releases) when APIs differ.
+
+Appwrite is an open-source backend as a service server that abstracts and simplifies 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. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
+
+![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)
+
+## Installation
+
+Requires Python 3.9 or later. Install the [`appwrite`](https://pypi.org/project/appwrite/) package from PyPI:
+
+```bash
+pip install appwrite
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add appwrite
+```
+
+## Getting started
+
+### Initialize the client
+
+Create a client with your Appwrite endpoint, project ID and an [API key](https://appwrite.io/docs/partners/project/api-keys). Find the endpoint and project ID in your project's **Settings** page, and create an API key with only the scopes you need under **API keys** in the project sidebar.
+
+```python
+from appwrite.client import Client
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1')
+client.set_project('<PROJECT_ID>')
+client.set_key('<API_KEY>')
+```
+
+API keys grant server-level access to your project. Keep them out of client-side code and version control.
+
+### Make a request
+
+Create a service object with the client and call any of its methods. Every method returns a typed Pydantic model, so response fields are available as attributes.
+
+```python
+from appwrite.id import ID
+from appwrite.services.users import Users
+
+users = Users(client)
+
+user = users.create(
+    user_id=ID.unique(),
+    email='email@example.com',
+    password='password',
+    name="Walter O'Brien",
+)
+
+print(user.id)
+print(user.name)
+print(user.to_dict())
+```
+
+See the [API reference](https://appwrite.io/docs/references/cloud/server-python/users) for every service and method.
+
+### Work with rows
+
+Use `TablesDB` to read and write rows. Pass a Pydantic model as `model_type` to get typed row data back; without it, `row.data` is a `dict`.
+
+```python
+from typing import Optional
+
+from pydantic import BaseModel
+
+from appwrite.id import ID
+from appwrite.query import Query
+from appwrite.services.tables_db import TablesDB
+
+
+class Post(BaseModel):
+    title: str
+    published: bool
+    excerpt: Optional[str] = None
+
+
+tables_db = TablesDB(client)
+
+row = tables_db.create_row(
+    database_id='<DATABASE_ID>',
+    table_id='<TABLE_ID>',
+    row_id=ID.unique(),
+    data={'title': 'Hello, world', 'published': True},
+    model_type=Post,
+)
+
+print(row.id)
+print(row.data.title)
+
+result = tables_db.list_rows(
+    database_id='<DATABASE_ID>',
+    table_id='<TABLE_ID>',
+    queries=[Query.equal('published', True), Query.limit(25)],
+    model_type=Post,
+)
+
+for row in result.rows:
+    print(row.data.title)
+```
+
+### Handle errors
+
+Failed requests raise `AppwriteException`, which carries `message`, `code`, `type` and `response`.
+
+```python
+from appwrite.exception import AppwriteException
+
+try:
+    user = users.get(user_id='<USER_ID>')
+except AppwriteException as error:
+    print(error.code, error.type, error.message)
+```
+
+### Self-hosted Appwrite
+
+Point the client at your own instance instead of Appwrite Cloud. Call `set_self_signed()` only in development, when the server uses a self-signed TLS certificate.
+
+```python
+client.set_endpoint('https://appwrite.example.com/v1')
+client.set_self_signed()
+```
+
+### Learn more
+
+- [Python quick start](https://appwrite.io/docs/quick-starts/python)
+- [Python API reference](https://appwrite.io/docs/references/cloud/server-python/users)
+- [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/main/CONTRIBUTING.md) before sending a pull-request.
+
+## License
+
+Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.

appwrite-26.0.0/README.md

@@ -0,0 +1,149 @@
+# Appwrite Python SDK
+
+![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg?style=flat-square)
+![Version](https://img.shields.io/badge/api%20version-2.5.0-blue.svg?style=flat-square)
+[![X Account](https://img.shields.io/badge/follow-%40appwrite-000000?logo=x&style=flat-square)](https://x.com/appwrite)
+[![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord)
+
+**This SDK targets Appwrite server version 2.5.x as shipped on Appwrite Cloud.** Self-hosted releases can lag behind Cloud — if you run an older self-hosted build, use a matching older SDK from [previous releases](https://github.com/appwrite/sdk-for-python/releases) when APIs differ.
+
+Appwrite is an open-source backend as a service server that abstracts and simplifies 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. For full API documentation and tutorials go to [https://appwrite.io/docs](https://appwrite.io/docs)
+
+![Appwrite](https://github.com/appwrite/appwrite/raw/main/public/images/github.png)
+
+## Installation
+
+Requires Python 3.9 or later. Install the [`appwrite`](https://pypi.org/project/appwrite/) package from PyPI:
+
+```bash
+pip install appwrite
+```
+
+Or with [uv](https://docs.astral.sh/uv/):
+
+```bash
+uv add appwrite
+```
+
+## Getting started
+
+### Initialize the client
+
+Create a client with your Appwrite endpoint, project ID and an [API key](https://appwrite.io/docs/partners/project/api-keys). Find the endpoint and project ID in your project's **Settings** page, and create an API key with only the scopes you need under **API keys** in the project sidebar.
+
+```python
+from appwrite.client import Client
+
+client = Client()
+client.set_endpoint('https://<REGION>.cloud.appwrite.io/v1')
+client.set_project('<PROJECT_ID>')
+client.set_key('<API_KEY>')
+```
+
+API keys grant server-level access to your project. Keep them out of client-side code and version control.
+
+### Make a request
+
+Create a service object with the client and call any of its methods. Every method returns a typed Pydantic model, so response fields are available as attributes.
+
+```python
+from appwrite.id import ID
+from appwrite.services.users import Users
+
+users = Users(client)
+
+user = users.create(
+    user_id=ID.unique(),
+    email='email@example.com',
+    password='password',
+    name="Walter O'Brien",
+)
+
+print(user.id)
+print(user.name)
+print(user.to_dict())
+```
+
+See the [API reference](https://appwrite.io/docs/references/cloud/server-python/users) for every service and method.
+
+### Work with rows
+
+Use `TablesDB` to read and write rows. Pass a Pydantic model as `model_type` to get typed row data back; without it, `row.data` is a `dict`.
+
+```python
+from typing import Optional
+
+from pydantic import BaseModel
+
+from appwrite.id import ID
+from appwrite.query import Query
+from appwrite.services.tables_db import TablesDB
+
+
+class Post(BaseModel):
+    title: str
+    published: bool
+    excerpt: Optional[str] = None
+
+
+tables_db = TablesDB(client)
+
+row = tables_db.create_row(
+    database_id='<DATABASE_ID>',
+    table_id='<TABLE_ID>',
+    row_id=ID.unique(),
+    data={'title': 'Hello, world', 'published': True},
+    model_type=Post,
+)
+
+print(row.id)
+print(row.data.title)
+
+result = tables_db.list_rows(
+    database_id='<DATABASE_ID>',
+    table_id='<TABLE_ID>',
+    queries=[Query.equal('published', True), Query.limit(25)],
+    model_type=Post,
+)
+
+for row in result.rows:
+    print(row.data.title)
+```
+
+### Handle errors
+
+Failed requests raise `AppwriteException`, which carries `message`, `code`, `type` and `response`.
+
+```python
+from appwrite.exception import AppwriteException
+
+try:
+    user = users.get(user_id='<USER_ID>')
+except AppwriteException as error:
+    print(error.code, error.type, error.message)
+```
+
+### Self-hosted Appwrite
+
+Point the client at your own instance instead of Appwrite Cloud. Call `set_self_signed()` only in development, when the server uses a self-signed TLS certificate.
+
+```python
+client.set_endpoint('https://appwrite.example.com/v1')
+client.set_self_signed()
+```
+
+### Learn more
+
+- [Python quick start](https://appwrite.io/docs/quick-starts/python)
+- [Python API reference](https://appwrite.io/docs/references/cloud/server-python/users)
+- [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/main/CONTRIBUTING.md) before sending a pull-request.
+
+## License
+
+Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/client.py

@@ -19,11 +19,11 @@ class Client:
         self._endpoint = 'https://cloud.appwrite.io/v1'
         self._global_headers = {
             'content-type': '',
-            'user-agent': f'AppwritePythonSDK/25.0.0 ({platform.uname().system}; {platform.uname().version}; {platform.uname().machine})',
+            'user-agent': f'AppwritePythonSDK/26.0.0 ({platform.uname().system}; {platform.uname().version}; {platform.uname().machine})',
             'x-sdk-name': 'Python',
             'x-sdk-platform': 'server',
             'x-sdk-language': 'python',
-            'x-sdk-version': '25.0.0',
+            'x-sdk-version': '26.0.0',
             'X-Appwrite-Response-Format': '2.5.0',
         }
         self._config = {}

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_bigint.py

@@ -13,6 +13,8 @@ class AttributeBigint(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -36,6 +38,7 @@ class AttributeBigint(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -56,6 +59,8 @@ class AttributeBigint(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_boolean.py

@@ -13,6 +13,8 @@ class AttributeBoolean(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -32,6 +34,7 @@ class AttributeBoolean(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -50,6 +53,8 @@ class AttributeBoolean(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_datetime.py

@@ -13,6 +13,8 @@ class AttributeDatetime(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -34,6 +36,7 @@ class AttributeDatetime(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -53,6 +56,8 @@ class AttributeDatetime(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_email.py

@@ -13,6 +13,8 @@ class AttributeEmail(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -34,6 +36,7 @@ class AttributeEmail(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -53,6 +56,8 @@ class AttributeEmail(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_enum.py

@@ -13,6 +13,8 @@ class AttributeEnum(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -36,6 +38,7 @@ class AttributeEnum(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -56,6 +59,8 @@ class AttributeEnum(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_float.py

@@ -13,6 +13,8 @@ class AttributeFloat(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -36,6 +38,7 @@ class AttributeFloat(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -56,6 +59,8 @@ class AttributeFloat(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_integer.py

@@ -13,6 +13,8 @@ class AttributeInteger(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -36,6 +38,7 @@ class AttributeInteger(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -56,6 +59,8 @@ class AttributeInteger(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_ip.py

@@ -13,6 +13,8 @@ class AttributeIp(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -34,6 +36,7 @@ class AttributeIp(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -53,6 +56,8 @@ class AttributeIp(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_line.py

@@ -13,6 +13,8 @@ class AttributeLine(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -32,6 +34,7 @@ class AttributeLine(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -50,6 +53,8 @@ class AttributeLine(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_longtext.py

@@ -13,6 +13,8 @@ class AttributeLongtext(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -34,6 +36,7 @@ class AttributeLongtext(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -53,6 +56,8 @@ class AttributeLongtext(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_mediumtext.py

@@ -13,6 +13,8 @@ class AttributeMediumtext(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -34,6 +36,7 @@ class AttributeMediumtext(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -53,6 +56,8 @@ class AttributeMediumtext(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data:

{appwrite-25.0.0 → appwrite-26.0.0}/appwrite/models/attribute_object.py

@@ -13,6 +13,8 @@ class AttributeObject(AppwriteModel):
     ----------
     key : str
         Attribute Key.
+    description : str
+        Optional description for the attribute.
     type : str
         Attribute type.
     status : AttributeStatus
@@ -30,6 +32,7 @@ class AttributeObject(AppwriteModel):
     """
 
     key: str = Field(..., alias='key')
+    description: str = Field(..., alias='description')
     type: str = Field(..., alias='type')
     status: AttributeStatus = Field(..., alias='status')
     error: str = Field(..., alias='error')
@@ -47,6 +50,8 @@ class AttributeObject(AppwriteModel):
         data = dict(data)
         if 'key' not in data:
             data['key'] = ''
+        if 'description' not in data:
+            data['description'] = ''
         if 'type' not in data:
             data['type'] = ''
         if 'error' not in data: