Metadata-Version: 2.4
Name: potluckdb
Version: 0.1.0
Summary: potluckdb local-first SQLite synchronization SDK
License-Expression: LicenseRef-Proprietary
License-File: LICENSE
License-File: THIRD_PARTY_NOTICES.txt
Requires-Python: >=3.14
Requires-Dist: potluckdb-storage==0.1.0
Project-URL: Documentation, https://docs.potluckdb.com/install/python/
Project-URL: Homepage, https://docs.potluckdb.com/
Description-Content-Type: text/markdown

# potluckdb for Python

potluckdb is a local-first SQLite synchronization SDK. This wheel
contains the application API and the runtime for the platform, and
depends on `potluckdb-storage`, which provides the S3, Google Cloud
Storage and Azure remotes, so no further installation step exists.

## Installation

```bash
pip install potluckdb
```

## Usage

```python
import potluckdb

remote = potluckdb.storage.from_s3("my-bucket", "notes", region="eu-west-1")
db = potluckdb.open("app.potluckdb", remote)
```

The [quickstart](https://docs.potluckdb.com/quickstart/python/) opens a
database on a directory remote; the
[storage reference](https://docs.potluckdb.com/reference/python/storage/)
gives each constructor's full signature.

See LICENSE.
