Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thijsmie/pocketbase
An async Python 3.11+ PocketBase SDK
https://github.com/thijsmie/pocketbase
async database pocketbase python rest
Last synced: 3 days ago
JSON representation
An async Python 3.11+ PocketBase SDK
- Host: GitHub
- URL: https://github.com/thijsmie/pocketbase
- Owner: thijsmie
- License: mit
- Created: 2024-01-29T10:17:35.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-10-15T13:24:11.000Z (27 days ago)
- Last Synced: 2024-11-01T03:11:55.249Z (10 days ago)
- Topics: async, database, pocketbase, python, rest
- Language: Python
- Homepage:
- Size: 85.9 KB
- Stars: 38
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-pocketbase - GitHub
- awesome-pocketbase - GitHub
- awesome-pocketbase - Python (Async) - PocketBase Client in Python.  (Unofficial PocketBase Clients (SDKs))
README
[](https://github.com/thijsmie/pocketbase-async)
[](https://github.com/thijsmie/pocketbase-async/blob/main/LICENSE.txt)
[](https://github.com/thijsmie/pocketbase-async/actions)
[](https://github.com/thijsmie/pocketbase-async/actions)
[](https://github.com/thijsmie/pocketbase-async/releases)
## About
PocketBase is an amazing tool to have in your developers backpack for a quick backend for your project. I found it pleasant to work with in Python but Vaphes existing Python SDK is in sync code while most of my application development is async these days. I started with a fork of Vaphes' SDK and tried to add async support but I gave up quite quickly and just started from scratch. You see the results here.
## Installation
Note that this package is compatible with Python 3.11 and up. You can install this package directly from PyPi:
```bash
pip install pocketbase-async
# or if you use poetry
poetry add pocketbase-async
```
## Usage
The API is mostly the same as the official JS SDK and the Vaphes Python SDK, with some exceptions. Authentication methods are namespaced under an extra `.auth`. There are some examples to help you along. More info to come.
- [View the examples](https://github.com/thijsmie/pocketbase-async/tree/main/examples)
## Roadmap
See the [project board](https://github.com/thijsmie/pocketbase-async/projects?query=is%3Aopen) for the list of planned work. See the [open issues](https://github.com/thijsmie/pocketbase-async/issues) for a full list of proposed features (and known issues).
## Contributing
Contributions are welcome and appreciated, be it typo-fix, feature or extensive rework. I recommend you to open an issue if you plan to spend significant effort on making a pull request, to avoid dual work or getting your work rejected if it really doesn't fit this project.
Don't forget to give the project a star! Thanks again!
1. Fork the project
2. Create your feature branch (`git checkout -b feat/some-nice-feature`)
3. Commit your changes (`git commit -m 'feat: Add some AmazingFeature'`)
4. Push to the pranch (`git push -u origin feat/some-nice-feature`)
5. Open a pull request
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Attributions
The `pocketbase-async` package was inspired and guided in implementation by several other projects:
- The official js sdk: https://github.com/pocketbase/js-sdk
- The Python SDK by Vaphes: https://github.com/vaphes/pocketbase
- The official documentation: https://pocketbase.io/docs/
Furthermore, a lot of the API tests were adapted from Vaphes' work (licensed MIT).
:arrow_up_small: Back to top
