1
0
Fork 0
mirror of synced 2024-06-14 08:44:49 +12:00
appwrite/docs/sdks/python/GETTING_STARTED.md

66 lines
2.5 KiB
Markdown
Raw Normal View History

2021-03-17 02:41:27 +13:00
## 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.
2021-03-17 02:41:27 +13:00
```python
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
2021-03-31 14:30:25 +13:00
.set_self_signed() # Use only on dev mode with a self-signed SSL cert
2021-03-17 02:41:27 +13:00
)
```
### Make Your First Request
2021-06-10 03:26:08 +12:00
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.
2021-03-17 02:41:27 +13:00
```python
users = Users(client)
2023-10-19 08:44:58 +13:00
result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")
2021-03-17 02:41:27 +13:00
```
### Full Example
```python
from appwrite.client import Client
from appwrite.services.users import Users
from appwrite.id import ID
2021-03-17 02:41:27 +13:00
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
2021-03-31 14:30:25 +13:00
.set_self_signed() # Use only on dev mode with a self-signed SSL cert
2021-03-17 02:41:27 +13:00
)
users = Users(client)
2023-10-19 08:44:58 +13:00
result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")
2021-03-17 02:41:27 +13:00
```
2021-03-26 21:37:57 +13:00
### 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.
```python
users = Users(client)
try:
2023-10-19 08:44:58 +13:00
result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")
2021-03-26 21:37:57 +13:00
except AppwriteException as e:
print(e.message)
```
2021-03-17 02:41:27 +13:00
### Learn more
2021-07-07 22:25:49 +12:00
You can use the following resources to learn more and get help
2021-03-17 02:41:27 +13:00
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-server)
- 📜 [Appwrite Docs](https://appwrite.io/docs)
- 💬 [Discord Community](https://appwrite.io/discord)
- 🚂 [Appwrite Python Playground](https://github.com/appwrite/playground-for-python)