Metadata-Version: 2.4
Name: edgebase-core
Version: 0.1.3
Summary: Shared Python core for EdgeBase table, storage, and HTTP primitives
Author: EdgeBase Team
License-Expression: MIT
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: httpx>=0.27
Description-Content-Type: text/markdown

# edgebase-core

Shared low-level Python primitives for EdgeBase.

`edgebase-core` is the foundation used by `edgebase` and `edgebase-admin`. It contains the HTTP client, table/query builder, storage helpers, push primitives, field operations, and common error types.

Most application code should install one of these instead:

- `pip install edgebase`
- `pip install edgebase-admin`

Install `edgebase-core` directly only if you are building custom wrappers, generated bindings, or internal integrations on top of the EdgeBase APIs.

## Docs

- SDK overview: https://edgebase.fun/docs/sdks
- Database admin SDK: https://edgebase.fun/docs/database/admin-sdk
- Storage docs: https://edgebase.fun/docs/storage/upload-download

## Quick Start

```python
from edgebase_core import HttpClient, StorageClient, TableRef

http = HttpClient(
    "https://your-project.edgebase.fun",
    service_key="service-key",
)

posts = (
    TableRef(http, "shared", None, "posts")
    .where("published", "==", True)
    .order_by("createdAt", "desc")
    .limit(20)
    .get_list()
)

bucket = StorageClient(http).bucket("avatars")
```

## Included Surfaces

- `HttpClient`
- `TableRef`, `DocRef`, `ListResult`
- `StorageClient`, `StorageBucket`
- `PushClient`
- `FieldOps`, `increment`, `delete_field`
- `ContextManager`
- `EdgeBaseError`

## AI Assistant

- Package guide: `packages/sdk/python/packages/core/README.md`
- Assistant reference: `packages/sdk/python/packages/core/llms.txt`

## Requirements

- Python `3.10+`
- `httpx>=0.27`
