Repository files navigation

This SDK is compatible with Appwrite server version 1.7.x. For older versions, please checkprevious 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. For full API documentation and tutorials go tohttps://appwrite.io/docs

To install viaPyPI:

pip install appwrite

Initialize your SDK with your Appwrite server API endpoint and project ID which can be found on your project settings page and your new API secret Key from project's API keys section.

fromappwrite.clientimportClientfromappwrite.services.usersimportUsersclient=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)

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 theAPI References section.

users=Users(client)result=users.create(ID.unique(),email="email@example.com",phone="+123456789",password="password",name="Walter O'Brien")

fromappwrite.clientimportClientfromappwrite.services.usersimportUsersfromappwrite.idimportIDclient=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(ID.unique(),email="email@example.com",phone="+123456789",password="password",name="Walter O'Brien")

The Appwrite Python SDK raisesAppwriteException object withmessage,code andresponse properties. You can handle any errors by catchingAppwriteException and present themessage to the user or handle it yourself based on the provided error information. Below is an example.

users=Users(client)try:result=users.create(ID.unique(),email="email@example.com",phone="+123456789",password="password",name="Walter O'Brien")exceptAppwriteExceptionase:print(e.message)

You can use the following resources to learn more and get help

• 🚀Getting Started Tutorial
• 📜Appwrite Docs
• 💬Discord Community
• 🚂Appwrite Python Playground

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

Please see theBSD-3-Clause license file for more information.