Appwrite Console Python SDK

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 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 Console 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

Installation

Requires Python 3.9 or later. Install the appwrite-console package from PyPI:

pip install appwrite-console

Or with uv:

uv add appwrite-console

Getting Started

The Appwrite Console SDK for Python drives the Console API — organizations, projects, billing, and everything else the Console itself calls. It is separate from sdk-for-python, which targets the public server API.

Installation

pip install appwrite-console

The package installs as appwrite-console and imports as appwrite_console, so it can sit alongside appwrite in the same environment.

Requirements: Python 3.9+

Init your SDK

from appwrite_console.client import Client

client = Client()
client.set_endpoint('https://cloud.appwrite.io/v1')
client.set_project('console')
client.set_session('your-console-session')

Console endpoints authenticate as a Console user, not with a project API key. Use set_session() with a Console session, or set_jwt() where you hold a token.

For a self-hosted instance with a self-signed certificate:

client.set_self_signed(True)  # Dev only

Organizations

from appwrite_console.services.organizations import Organizations

organizations = Organizations(client)

result = organizations.list()
for organization in result.teams:
    print(organization.id, organization.name)

Projects

Projects are scoped to an organization:

from appwrite_console.services.organization import Organization

organization = Organization(client)
organization.client.set_organization('your-organization-id')

projects = organization.list_projects()
for project in projects.projects:
    print(project.id, project.name)

project = organization.get_project('your-project-id')

Queries

from appwrite_console.query import Query

result = organization.list_projects(queries=[
    Query.limit(25),
    Query.order_desc('$createdAt'),
])

Error handling

from appwrite_console.exception import AppwriteException

try:
    project = organization.get_project('missing-project')
except AppwriteException as error:
    print(error.message, error.code, error.type)

Full example

from appwrite_console.client import Client
from appwrite_console.services.organizations import Organizations
from appwrite_console.services.organization import Organization
from appwrite_console.exception import AppwriteException

client = Client()
client.set_endpoint('https://cloud.appwrite.io/v1')
client.set_project('console')
client.set_session('your-console-session')

organizations = Organizations(client)
organization = Organization(client)

try:
    for team in organizations.list().teams:
        client.set_organization(team.id)

        for project in organization.list_projects().projects:
            print(f'{team.name} / {project.name} ({project.id})')
except AppwriteException as error:
    print(f'Error: {error.message}')

Contribution

This library is auto-generated by Appwrite custom SDK Generator. To learn more about how you can help us improve this SDK, please check the contribution guide before sending a pull-request.

License

Please see the BSD-3-Clause license file for more information.