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
Copy file name to clipboardExpand all lines: README.md
+62-64Lines changed: 62 additions & 64 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,7 +59,15 @@ More information about the API can be found at https://clerk.com/docs
59
59
>
60
60
> Once a Python version reaches its [official end of life date](https://devguide.python.org/versions/), a 3-month grace period is provided for users to upgrade. Following this grace period, the minimum python version supported in the SDK will be updated.
61
61
62
-
The SDK can be installed with either *pip* or *poetry* package managers.
62
+
The SDK can be installed with *uv*, *pip*, or *poetry* package managers.
63
+
64
+
### uv
65
+
66
+
*uv* is a fast Python package installer and resolver, designed as a drop-in replacement for pip and pip-tools. It's recommended for its speed and modern Python tooling capabilities.
67
+
68
+
```bash
69
+
uv add clerk-backend-api
70
+
```
63
71
64
72
### PIP
65
73
@@ -143,7 +151,7 @@ with Clerk(
143
151
144
152
</br>
145
153
146
-
The same SDK client can also be used to make asychronous requests by importing asyncio.
154
+
The same SDK client can also be used to make asynchronous requests by importing asyncio.
147
155
```python
148
156
# Asynchronous Example
149
157
import asyncio
@@ -190,27 +198,6 @@ with Clerk(
190
198
191
199
# Use the SDK ...
192
200
193
-
```
194
-
195
-
### Per-Operation Security Schemes
196
-
197
-
Some operations in this SDK require the security scheme to be specified at the request level. For example:
198
-
```python
199
-
import clerk_backend_api
200
-
from clerk_backend_api import Clerk
201
-
202
-
203
-
with Clerk() as clerk:
204
-
205
-
res = clerk.management.upsert_user(security=clerk_backend_api.ManagementUpsertUserSecurity(
|`.raw_response`|*httpx.Response*| The raw HTTP response |
616
-
|`.body`|*str*| The response content |
617
-
618
-
When custom error responses are specified for an operation, the SDK may also raise their associated exceptions. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `create_async` method may raise the following exceptions:
**Inherit from [`ClerkBaseError`](./src/clerk_backend_api/models/clerkbaseerror.py)**:
646
+
*[`VerifyOAuthAccessTokenOauthAccessTokensResponseBody`](./src/clerk_backend_api/models/verifyoauthaccesstokenoauthaccesstokensresponsebody.py): 400 Bad Request. Status code `400`. Applicable to 1 of 146 methods.*
647
+
*[`VerifyOAuthAccessTokenOauthAccessTokensResponseResponseBody`](./src/clerk_backend_api/models/verifyoauthaccesstokenoauthaccesstokensresponseresponsebody.py): 404 Not Found. Status code `404`. Applicable to 1 of 146 methods.*
648
+
*[`ResponseValidationError`](./src/clerk_backend_api/models/responsevalidationerror.py): Type mismatch between the response data and the expected Pydantic model. Provides access to the Pydantic validation error via the `cause` attribute.
649
+
650
+
</details>
651
+
652
+
\* Check [the method documentation](#available-resources-and-operations) to see if the error is applicable.
0 commit comments