Skip to main content

Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API

Project description

Appwrite Python SDK

License Version Build Status Twitter Account Discord

This SDK is compatible with Appwrite server version 1.7.x. For older versions, please check previous 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 to https://appwrite.io/docs

Appwrite

Installation

To install via PyPI:

pip install appwrite

Getting Started

Init your SDK

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.

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.

users = Users(client)

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

Full Example

from appwrite.client import Client
from appwrite.services.users import Users
from appwrite.id import ID

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

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.

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

Learn more

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

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

appwrite-11.0.0.tar.gz (53.8 kB view details)

Uploaded Source

Built Distribution

appwrite-11.0.0-py3-none-any.whl (67.0 kB view details)

Uploaded Python 3

File details

Details for the file appwrite-11.0.0.tar.gz.

File metadata

  • Download URL: appwrite-11.0.0.tar.gz
  • Upload date:
  • Size: 53.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for appwrite-11.0.0.tar.gz
Algorithm Hash digest
SHA256 6a40f20a0d74fec6b1c2f276756dbba1c8789c8256544c1a035feffae8ff3437
MD5 fa4be92463ed0dc287860b5015606a94
BLAKE2b-256 936790bef0abe93ca61e63dc2323a459ad4f3f09725d88d4edc7791a07dd30c0

See more details on using hashes here.

File details

Details for the file appwrite-11.0.0-py3-none-any.whl.

File metadata

  • Download URL: appwrite-11.0.0-py3-none-any.whl
  • Upload date:
  • Size: 67.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for appwrite-11.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dd363769bd975ff72ab83a9e4f37534f9e3b08c20c5e1328cfed5920d979f33a
MD5 d117d5e7453eaa252590c5454b25ce25
BLAKE2b-256 2831f996e798e9fb9644ad876030eca95cda872b8f4b83581da35fa6a99c7cbe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page