You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Summary: Appwrite is an open-source self-hosted backend server that abstract and simplify complex and repetitive development tasks behind a very simple REST API
**This SDK is compatible with Appwrite server version 1.3.x. For older versions, please check [previous releases](https://github.com/appwrite/sdk-for-python/releases).**
34
+
35
+
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](https://appwrite.io/docs)
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.
52
+
53
+
```python
54
+
from appwrite.client import Client
55
+
from appwrite.services.users import Users
56
+
57
+
client = Client()
58
+
59
+
(client
60
+
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
61
+
.set_project('5df5acd0d48c2') # Your project ID
62
+
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
63
+
.set_self_signed() # Use only on dev mode with a self-signed SSL cert
64
+
)
65
+
```
66
+
67
+
### Make Your First Request
68
+
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](https://appwrite.io/docs) section.
69
+
70
+
```python
71
+
users = Users(client)
72
+
73
+
result = users.create('[USER_ID]', 'email@example.com', 'password')
74
+
```
75
+
76
+
### Full Example
77
+
```python
78
+
from appwrite.client import Client
79
+
from appwrite.services.users import Users
80
+
from appwrite.id import ID
81
+
82
+
client = Client()
83
+
84
+
(client
85
+
.set_endpoint('https://[HOSTNAME_OR_IP]/v1') # Your API Endpoint
86
+
.set_project('5df5acd0d48c2') # Your project ID
87
+
.set_key('919c2d18fb5d4...a2ae413da83346ad2') # Your secret API key
88
+
.set_self_signed() # Use only on dev mode with a self-signed SSL cert
89
+
)
90
+
91
+
users = Users(client)
92
+
93
+
result = users.create(ID.unique(), 'email@example.com', 'password')
94
+
```
95
+
96
+
### Error Handling
97
+
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.
98
+
99
+
```python
100
+
users = Users(client)
101
+
try:
102
+
result = users.create(ID.unique(), 'email@example.com', 'password')
103
+
except AppwriteException as e:
104
+
print(e.message)
105
+
```
106
+
107
+
### Learn more
108
+
You can use the following resources to learn more and get help
109
+
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
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.
118
+
119
+
## License
120
+
121
+
Please see the [BSD-3-Clause license](https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE) file for more information.
0 commit comments