Skip to main content

Python SDK for the Areev knowledge database — HTTP, gRPC, and MCP transports

Project description

Areev Python SDK

Python client library for the Areev knowledge database.

Installation

pip install areev

For gRPC transport:

pip install areev[grpc]

Quick Start

from areev import Areev

areev = Areev()  # reads AREEV_API_KEY, AREEV_URL from env
areev.remember("John likes coffee")

results = areev.recall("what does John like?")
for hit in results.results:
    print(f"  {hit.grain_type}: {hit.fields}")

Configuration

The client reads from environment variables by default:

Variable Default Description
AREEV_API_KEY API key (sent as X-API-Key header)
AREEV_URL https://app.areev.ai Server endpoint
AREEV_MEMORY_ID default Memory database ID

Or pass them explicitly:

areev = Areev(api_key="ar_...", url="https://dub.areev.ai", memory_id="my-memory")

Async

from areev import AsyncAreev

async with AsyncAreev() as areev:
    await areev.remember("John likes coffee")
    results = await areev.recall("what does John like?")

API

Method Description
remember(text) Store natural-language memory (LLM extracts structure)
recall(query) Search memories
forget(hash) Delete a memory by hash
add(grain_type, **fields) Add a typed grain (low-level)
get(hash) Get a grain by hash
supersede(old_hash, grain_type, **fields) Update a grain
health() Health check
stats() Database statistics
flush() Flush write buffer

Low-Level Client

For advanced use cases (custom request objects, full async control):

from areev import HttpClient, AreevConfig, AddRequest, GrainType

config = AreevConfig(url="http://localhost:4009", memory_id="default", api_key="your-key")
async with HttpClient(config) as client:
    resp = await client.add(AddRequest(
        grain_type=GrainType.BELIEF,
        fields={"subject": "john", "relation": "likes", "object": "coffee"},
    ))

Transports

Transport Extra Status
HTTP/REST (default) Available
gRPC areev[grpc] Available
MCP Planned

Code Generation

Generate gRPC stubs and Pydantic models from the Areev spec:

pip install areev[dev]
./scripts/generate.sh

License

BUSL-1.1

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

areev-0.0.0.tar.gz (82.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

areev-0.0.0-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

Details for the file areev-0.0.0.tar.gz.

File metadata

  • Download URL: areev-0.0.0.tar.gz
  • Upload date:
  • Size: 82.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for areev-0.0.0.tar.gz
Algorithm Hash digest
SHA256 45f855da737607e1ffeec119cccee6a23a533cb3d386a5eb362fc3ae337d556f
MD5 9d89829d09571fa833ef89064fe6addf
BLAKE2b-256 4068a4f1965addf9067ad1238f95723ed5333399f3f9273e9de6678c988f9959

See more details on using hashes here.

File details

Details for the file areev-0.0.0-py3-none-any.whl.

File metadata

  • Download URL: areev-0.0.0-py3-none-any.whl
  • Upload date:
  • Size: 8.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.14

File hashes

Hashes for areev-0.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ae056f172d71d55c86247fd7f39205bcac405df1abf1ba3d8e5fa418572270d5
MD5 11624803e0f8d8937f1a209497bfc997
BLAKE2b-256 c49e7b32a8dc56f33f000a09a8ba06537c00f2b166a38b25be12044b95e0af8b

See more details on using hashes here.

Supported by

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