Skip to main content

Async pocketbase SDK for Python

Project description

Static Badge License: MIT Checks status Coverage GitHub Release


Logo

pocketbase-async

An async Python 3.11+ PocketBase SDK


Repository
Report Bug · Request Feature

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:

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.

Roadmap

See the project board for the list of planned work. See the open 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:

Furthermore, a lot of the API tests were adapted from Vaphes' work (licensed MIT).


:arrow_up_small: Back to top

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pocketbase_async-0.11.0.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

pocketbase_async-0.11.0-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

Details for the file pocketbase_async-0.11.0.tar.gz.

File metadata

  • Download URL: pocketbase_async-0.11.0.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for pocketbase_async-0.11.0.tar.gz
Algorithm Hash digest
SHA256 6878e5a4c25a3a4f9abe5b680990d0f624058d0267176653180fc6422efd5d0d
MD5 83584e64841cc81dc341f41ece10b5a9
BLAKE2b-256 78c66c9abb9f91fcb4085a5309f453756063ecc9a31b20d1cddfa48d2741d6de

See more details on using hashes here.

File details

Details for the file pocketbase_async-0.11.0-py3-none-any.whl.

File metadata

File hashes

Hashes for pocketbase_async-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 80b5279f20d7cec9ebd7780453ada8a5dc7fba2f347a512744e12d03cfc887c4
MD5 3c7d18a7e70aca90d6a46bd2e9cbc2d5
BLAKE2b-256 769d3f6977a5ea664459c2eb3a86241a7f0a2db550e6acfbae49849c98596ef1

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page