Skip to content

Commit

Permalink
Merge pull request #6826 from GuptaPratik02/doc-sdks-python-update-ge…
Browse files Browse the repository at this point in the history
…tting-started-guide

Update GETTING_STARTED.md
  • Loading branch information
eldadfux committed Feb 20, 2024
2 parents 0f7c73c + f287e60 commit 14e81c2
Show file tree
Hide file tree
Showing 16 changed files with 68 additions and 56 deletions.
14 changes: 8 additions & 6 deletions docs/sdks/android/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,8 +52,9 @@ When trying to connect to Appwrite from an emulator or a mobile device, localhos
val account = Account(client)
val response = account.create(
ID.unique(),
"email@example.com",
"password"
"email@example.com",
"password",
"Walter O'Brien"
)
```

Expand All @@ -72,8 +73,9 @@ val client = Client(context)
val account = Account(client)
val user = account.create(
ID.unique(),
"email@example.com",
"password"
"email@example.com",
"password",
"Walter O'Brien"
)
```

Expand All @@ -82,7 +84,7 @@ The Appwrite Android SDK raises an `AppwriteException` object with `message`, `c

```kotlin
try {
var user = account.create(ID.unique(), "email@example.com", "password")
var user = account.create(ID.unique(),"email@example.com","password","Walter O'Brien")
Log.d("Appwrite user", user.toMap())
} catch(e : AppwriteException) {
e.printStackTrace()
Expand All @@ -94,4 +96,4 @@ You can use the following resources to learn more and get help
- 🚀 [Getting Started Tutorial](https://appwrite.io/docs/getting-started-for-android)
- 📜 [Appwrite Docs](https://appwrite.io/docs)
- 💬 [Discord Community](https://appwrite.io/discord)
- 🚂 [Appwrite Android Playground](https://github.com/appwrite/playground-for-android)
- 🚂 [Appwrite Android Playground](https://github.com/appwrite/playground-for-android)
14 changes: 8 additions & 6 deletions docs/sdks/apple/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,10 @@ let account = Account(client)

do {
let user = try await account.create(
userId: ID.unique(),
email: "email@example.com",
password: "password"
userId: ID.unique(),
email: "email@example.com",
password: "password",
name: "Walter O'Brien"
)
print(String(describing: user.toMap()))
} catch {
Expand All @@ -100,9 +101,10 @@ func main() {

do {
let user = try await account.create(
userId: ID.unique(),
email: "email@example.com",
password: "password"
userId: ID.unique(),
email: "email@example.com",
password: "password",
name: "Walter O'Brien"
)
print(String(describing: account.toMap()))
} catch {
Expand Down
10 changes: 6 additions & 4 deletions docs/sdks/dart/EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@ Create a new user:
Users users = Users(client);
User result = await users.create(
userId: '[USER_ID]',
email: 'email@example.com',
password: 'password',
userId: ID.unique(),
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "Walter O'Brien"
);
```

Expand Down Expand Up @@ -57,4 +59,4 @@ storage.createFile(
});
```

All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
4 changes: 2 additions & 2 deletions docs/sdks/dart/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ void main() async {
Users users = Users(client);
try {
final user = await users.create(userId: ID.unique(), email: email@example.com’,password: password, name: ‘name’);
final user = await users.create(userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
print(user.toMap());
} on AppwriteException catch(e) {
print(e.message);
Expand All @@ -31,7 +31,7 @@ The Appwrite Dart SDK raises `AppwriteException` object with `message`, `code` a
Users users = Users(client);
try {
final user = await users.create(userId: ID.unique(), email: email@example.com’,password: password, name: ‘name’);
final user = await users.create(userId: ID.unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
print(user.toMap());
} on AppwriteException catch(e) {
//show message to user or do other operation based on error as required
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/deno/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```typescript
let users = new sdk.Users(client);

let user = await users.create(ID.unique(), 'email@example.com', 'password');
let user = await users.create(ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
console.log(user);
```

Expand All @@ -39,7 +39,7 @@ client
.setSelfSigned() // Use only on dev mode with a self-signed SSL cert
;

let user = await users.create(ID.unique(), 'email@example.com', 'password');
let user = await users.create(ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
console.log(user);
```

Expand All @@ -50,7 +50,7 @@ The Appwrite Deno SDK raises `AppwriteException` object with `message`, `code` a
let users = new sdk.Users(client);

try {
let user = await users.create(ID.unique(), 'email@example.com', 'password');
let user = await users.create(ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
} catch(e) {
console.log(e.message);
}
Expand Down
6 changes: 4 additions & 2 deletions docs/sdks/dotnet/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,9 @@ var users = new Users(client);
var user = await users.Create(
userId: ID.Unique(),
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "name");
name: "Walter O'Brien");

Console.WriteLine(user.ToMap());
```
Expand All @@ -35,8 +36,9 @@ try
var user = await users.Create(
userId: ID.Unique(),
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "name");
name: "Walter O'Brien");
}
catch (AppwriteException e)
{
Expand Down
4 changes: 2 additions & 2 deletions docs/sdks/flutter-dev/EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Create a new user and session:
```dart
Account account = Account(client);
final user = await account.create(userId: '[USER_ID]', email: 'me@appwrite.io', password: 'password', name: 'My Name');
final user = await account.create(userId: ID.unique(), email: "email@example.com", password: "password", name: "Walter O'Brien");
final session = await account.createEmailSession(email: 'me@appwrite.io', password: 'password');
Expand Down Expand Up @@ -60,4 +60,4 @@ storage.createFile(
});
```

All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
4 changes: 2 additions & 2 deletions docs/sdks/flutter/EXAMPLES.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Create a new user and session:
```dart
Account account = Account(client);
final user = await account.create(userId: '[USER_ID]', email: 'me@appwrite.io', password: 'password', name: 'My Name');
final user = await account.create(userId: ID.unique(), email: "email@example.com", password: "password", name: "Walter O'Brien");
final session = await account.createEmailSession(email: 'me@appwrite.io', password: 'password');
Expand Down Expand Up @@ -60,4 +60,4 @@ storage.createFile(
});
```

All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
All examples and API features are available at the [official Appwrite docs](https://appwrite.io/docs)
12 changes: 3 additions & 9 deletions docs/sdks/flutter/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,10 +105,7 @@ When trying to connect to Appwrite from an emulator or a mobile device, localhos
Account account = Account(client);
final user = await account
.create(
userId: ID.unique(),
email: 'me@appwrite.io',
password: 'password',
name: 'My Name'
userId: ID.unique(), email: "email@example.com", password: "password", name: "Walter O'Brien"
);
```

Expand All @@ -133,10 +130,7 @@ void main() {
final user = await account
.create(
userId: ID.unique(),
email: 'me@appwrite.io',
password: 'password',
name: 'My Name'
userId: ID.unique(), email: "email@example.com", password: "password", name: "Walter O'Brien"
);
}
```
Expand All @@ -148,7 +142,7 @@ The Appwrite Flutter SDK raises `AppwriteException` object with `message`, `type
Account account = Account(client);
try {
final user = await account.create(userId: ID.unique(), email: email@example.com’,password: password, name: ‘name’);
final user = await account.create(userId: ID.unique(), email: "email@example.com", password: "password", name: "Walter O'Brien");
print(user.toMap());
} on AppwriteException catch(e) {
//show message to user or do other operation based on error as required
Expand Down
6 changes: 6 additions & 0 deletions docs/sdks/kotlin/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,9 @@ val users = Users(client)
val user = users.create(
user = ID.unique(),
email = "email@example.com",
phone = "+123456789",
password = "password",
name = "Walter O'Brien"
)
```

Expand All @@ -48,7 +50,9 @@ suspend fun main() {
val user = users.create(
user = ID.unique(),
email = "email@example.com",
phone = "+123456789",
password = "password",
name = "Walter O'Brien"
)
}
```
Expand All @@ -68,7 +72,9 @@ suspend fun main() {
val user = users.create(
user = ID.unique(),
email = "email@example.com",
phone = "+123456789",
password = "password",
name = "Walter O'Brien"
)
} catch (e: AppwriteException) {
e.printStackTrace()
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/nodejs/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```js
let users = new sdk.Users(client);

let promise = users.create(sdk.ID.unique(), 'email@example.com', undefined, 'password', 'Jane Doe');
let promise = users.create(sdk.ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");

promise.then(function (response) {
console.log(response);
Expand All @@ -45,7 +45,7 @@ client
;

let users = new sdk.Users(client);
let promise = users.create(sdk.ID.unique(), 'email@example.com', undefined, 'password', 'Jane Doe');
let promise = users.create(sdk.ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");

promise.then(function (response) {
console.log(response);
Expand All @@ -61,7 +61,7 @@ The Appwrite Node SDK raises `AppwriteException` object with `message`, `code` a
let users = new sdk.Users(client);

try {
let res = await users.create(sdk.ID.unique(), 'email@example.com', 'password');
let res = await users.create(sdk.ID.unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
} catch(e) {
console.log(e.message);
}
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/php/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```php
$users = new Users($client);

$user = $users->create(ID::unique(), 'email@example.com', 'password');
$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
```

### Full Example
Expand All @@ -40,7 +40,7 @@ $client

$users = new Users($client);

$user = $users->create(ID::unique(), 'email@example.com', 'password');
$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
```

### Error Handling
Expand All @@ -49,7 +49,7 @@ The Appwrite PHP SDK raises `AppwriteException` object with `message`, `code` an
```php
$users = new Users($client);
try {
$user = $users->create(ID::unique(), 'email@example.com', 'password');
$user = $users->create(ID::unique(), "email@example.com", "+123456789", "password", "Walter O'Brien");
} catch(AppwriteException $error) {
echo $error->message;
}
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/python/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```python
users = Users(client)

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

### Full Example
Expand All @@ -43,7 +43,7 @@ client = Client()

users = Users(client)

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

### Error Handling
Expand All @@ -52,7 +52,7 @@ The Appwrite Python SDK raises `AppwriteException` object with `message`, `code`
```python
users = Users(client)
try:
result = users.create(ID.unique(), 'email@example.com', 'password')
result = users.create(ID.unique(), email = "email@example.com", phone = "+123456789", password = "password", name = "Walter O'Brien")
except AppwriteException as e:
print(e.message)
```
Expand Down
6 changes: 3 additions & 3 deletions docs/sdks/ruby/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Once your SDK object is set, create any of the Appwrite service objects and choo
```ruby
users = Appwrite::Users.new(client);

user = users.create(userId: Appwrite::ID::unique(), email: 'email@example.com', password: 'password');
user = users.create(userId: Appwrite::ID::unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
```

### Full Example
Expand All @@ -40,7 +40,7 @@ client

users = Appwrite::Users.new(client);

user = users.create(userId: Appwrite::ID::unique(), email: 'email@example.com', password: 'password');
user = users.create(userId: Appwrite::ID::unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
```

### Error Handling
Expand All @@ -50,7 +50,7 @@ The Appwrite Ruby SDK raises `Appwrite::Exception` object with `message`, `code`
users = Appwrite::Users.new(client);

begin
user = users.create(userId: Appwrite::ID::unique(), email: 'email@example.com', password: 'password');
user = users.create(userId: Appwrite::ID::unique(), email: "email@example.com", phone: "+123456789", password: "password", name: "Walter O'Brien");
rescue Appwrite::Exception => error
puts error.message
end
Expand Down
16 changes: 10 additions & 6 deletions docs/sdks/swift/GETTING_STARTED.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,11 @@ let users = Users(client)

do {
let user = try await users.create(
userId: ID.unique(),
email: "email@example.com",
password: "password"
userId: ID.unique(),
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "Walter O'Brien"
)
print(String(describing: user.toMap()))
} catch {
Expand All @@ -51,9 +53,11 @@ func main() {

do {
let user = try await users.create(
userId: ID.unique(),
email: "email@example.com",
password: "password"
userId: ID.unique(),
email: "email@example.com",
phone: "+123456789",
password: "password",
name: "Walter O'Brien"
)
print(String(describing: user.toMap()))
} catch {
Expand Down

0 comments on commit 14e81c2

Please sign in to comment.