diff --git a/README.md b/README.md index f8234f5..e086717 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,11 @@ # Appwrite Console Python SDK -![License](https://img.shields.io/github/license/appwrite/sdk-for-console-python.svg?style=flat-square) -![Version](https://img.shields.io/badge/api%20version-2.4.0-blue.svg?style=flat-square) -[![Build Status](https://img.shields.io/travis/com/appwrite/sdk-generator?style=flat-square)](https://travis-ci.com/appwrite/sdk-generator) -[![Twitter Account](https://img.shields.io/twitter/follow/appwrite?color=00acee&label=twitter&style=flat-square)](https://twitter.com/appwrite) +![License](https://img.shields.io/badge/license-BSD--3--Clause-blue.svg?style=flat-square) +![Version](https://img.shields.io/badge/api%20version-2.5.0-blue.svg?style=flat-square) +[![X Account](https://img.shields.io/badge/follow-%40appwrite-000000?logo=x&style=flat-square)](https://x.com/appwrite) [![Discord](https://img.shields.io/discord/564160730845151244?label=discord&style=flat-square)](https://appwrite.io/discord) -**This SDK targets Appwrite server version 2.4.x as shipped on Appwrite Cloud.** Self-hosted releases can lag behind Cloud — if you run an older self-hosted build, use a matching older SDK from [previous releases](https://github.com/appwrite/sdk-for-console-python/releases) when APIs differ. +**This SDK targets Appwrite server version 2.5.x as shipped on Appwrite Cloud.** Self-hosted releases can lag behind Cloud — if you run an older self-hosted build, use a matching older SDK from [previous releases](https://github.com/appwrite/sdk-for-console-python/releases) when APIs differ. Appwrite is an open-source backend as a service server that abstracts and simplifies 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 Console 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) @@ -14,19 +13,18 @@ Appwrite is an open-source backend as a service server that abstracts and simpli ## Installation -To install via [PyPI](https://pypi.org/): +Requires Python 3.9 or later. Install the [`appwrite-console`](https://pypi.org/project/appwrite-console/) package from PyPI: ```bash pip install appwrite-console ``` -Or with `uv`: +Or with [uv](https://docs.astral.sh/uv/): ```bash uv add appwrite-console ``` - ## Getting Started The Appwrite Console SDK for Python drives the Console API — organizations, projects, @@ -142,10 +140,9 @@ except AppwriteException as error: print(f'Error: {error.message}') ``` - ## Contribution -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. +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/main/CONTRIBUTING.md) before sending a pull-request. ## License