https://github.com/appwrite/playground-for-python

Simple examples that help you get started with Appwrite + Python (=❤️)
https://github.com/appwrite/playground-for-python

appwrite hacktoberfest python

Last synced: about 1 month ago
JSON representation

Simple examples that help you get started with Appwrite + Python (=❤️)

• Host: GitHub
• URL: https://github.com/appwrite/playground-for-python
• Owner: appwrite
• License: mit
• Created: 2020-09-19T11:03:42.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-18T10:48:46.000Z (4 months ago)
• Last Synced: 2024-06-07T08:34:30.053Z (3 months ago)
• Topics: appwrite, hacktoberfest, python
• Language: Python
• Homepage: https://appwrite.io
• Size: 66.4 KB
• Stars: 63
• Watchers: 23
• Forks: 50
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-appwrite - Playground for Python

README

        
# Appwrite's Python Playground 🎮

Appwrite playground is a simple way to explore the Appwrite API & Appwrite Python SDK. Use the source code of this repository to learn how to use the different Appwrite Python SDK features.

**Work in progress**

## System Requirements

* A system with Python 3+ or Docker installed.

* An Appwrite instance.

* An Appwrite project created in the console.

* An Appwrite API key created in the console.

### Installation

1. Clone this repository.

2. `cd` into the repository.

3. Open the playground.py file found in the root of the cloned repository.

4. Copy Project ID, endpoint and API key from Appwrite console into `playground.py`

5. Run the playground:

    Python:

        - Install dependencies using pip `pip install -r requirements.txt`

        - Execute the command `python playground.py`

    Docker:

        - Execute the command `docker compose up`

6. You will see the JSON response in the console.

### API's Covered

- Database

    * Create Collection

    * List Collections

    * Add Document

    * List Documents

    * Delete Document

    * Delete Collection

- Storage

    * Create Bucket

    * List Buckets

    * Upload File

    * List Files

    * Delete File

    * Delete Bucket

- Users

    * Create User

    * List Users

    * Delete User

- Functions

    * Create Function

    * List Functions

    * Delete Function

## Contributing

All code contributions - including those of people having commit access - must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.

We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](https://github.com/appwrite/appwrite/blob/master/CONTRIBUTING.md).

## Security

For security issues, kindly email us [[email protected]](mailto:[email protected]) instead of posting a public issue in GitHub.

## Follow Us

Join our growing community around the world! Follow us on [Twitter](https://twitter.com/appwrite), [Facebook Page](https://www.facebook.com/appwrite.io), [Facebook Group](https://www.facebook.com/groups/appwrite.developers/) or join our [Discord Server](https://appwrite.io/discord) for more help, ideas and discussions.