Skip to main content

Core client SDK for the Copass platform (Python mirror of @copass/core)

Project description

copass-core

Core client SDK for the Copass platform. Python mirror of @copass/core — shared foundation for every Python Copass adapter.

Install

pip install copass-core

Requires httpx>=0.27. Python ≥ 3.10.

Quickstart

import asyncio
from copass_core import CopassClient, ApiKeyAuth

async def main():
    client = CopassClient(auth=ApiKeyAuth(key="olk_..."))

    # Retrieval
    menu = await client.retrieval.discover(
        sandbox_id="sb_...",
        query="How does auth work?",
    )
    print(menu["items"])

    # Context for agent
    context = await client.context.for_agent(
        sandbox_id="sb_...",
        tier="adaptive",
        query="auth flow",
    )
    print(context)

asyncio.run(main())

Auth options

from copass_core import CopassClient, ApiKeyAuth, BearerAuth, ProviderAuth

# Long-lived API key (olk_ prefix)
CopassClient(auth=ApiKeyAuth(key="olk_..."))

# Raw Bearer JWT (caller owns refresh)
CopassClient(auth=BearerAuth(token="eyJ..."))

# Custom AuthProvider implementation
class MyProvider:
    async def get_session(self):
        from copass_core import SessionContext
        return SessionContext(access_token=await _mint_token())

CopassClient(auth=ProviderAuth(provider=MyProvider()))

Available resources

Full resource surface matching @copass/core:

client = CopassClient(auth=ApiKeyAuth(key="olk_..."))

# Narrow retrieval tools
await client.retrieval.discover(sandbox_id, query="...")
await client.retrieval.interpret(sandbox_id, query="...", items=[...])
await client.retrieval.search(sandbox_id, query="...")
await client.context.for_agent(sandbox_id="...", tier="adaptive")

# Storage layer
await client.sandboxes.create(name="...", owner_id="...")
await client.sources.register(sandbox_id, provider="custom", name="...")
await client.ingest.text_in_sandbox(sandbox_id, text="...")
await client.projects.create(sandbox_id, name="...")
await client.vault.store(sandbox_id, "key/path", b"bytes")

# Knowledge graph
await client.entities.search(sandbox_id, q="auth")
await client.matrix.query(query="...")

# Account
await client.users.get_profile()
await client.api_keys.create(name="ci")
await client.usage.get_balance()

# Higher-order — ephemeral data source wrapping agent conversation
window = await client.context_window.create(sandbox_id=sandbox_id)
await window.add_turn(ChatMessage(role="user", content="..."))
# Pass directly to retrieval for window-aware calls:
await client.retrieval.search(sandbox_id, query="...", window=window)

v0.2 scope

Shipped in v0.2:

  • Full resource surface (12 resource classes, all public paths).
  • ContextWindow + ContextWindowResource.
  • BaseDataSource + ensure_data_source for custom driver subclasses.
  • HttpClient raw-body / raw-response support (enables vault blob I/O).

Deferred to v0.3:

  • Crypto primitives (HKDF, AES-GCM, session tokens, DEK).
  • Supabase OTP auth provider (requires crypto).
  • BearerAuth(encryption_key=...) currently stores the key but doesn't derive a session token — works when the server doesn't demand one.

Open a PR with a scoped addition if you need those sooner.

License

MIT.

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

copass_core-1.0.3.tar.gz (35.4 kB view details)

Uploaded Source

Built Distribution

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

copass_core-1.0.3-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

Details for the file copass_core-1.0.3.tar.gz.

File metadata

  • Download URL: copass_core-1.0.3.tar.gz
  • Upload date:
  • Size: 35.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for copass_core-1.0.3.tar.gz
Algorithm Hash digest
SHA256 a0284549e68eec420feb10f9671246eee12c1a8f21d94b76ec90a1fceae16b71
MD5 3223c0f9bdc3b18bdd5f663bb41f82c2
BLAKE2b-256 1a0dd4ce777692d28d92378022cbba750e19330977701131e756ba7e5374f735

See more details on using hashes here.

Provenance

The following attestation bundles were made for copass_core-1.0.3.tar.gz:

Publisher: release-python.yml on olane-labs/copass

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file copass_core-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: copass_core-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 42.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for copass_core-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 8fd730683445fdc6bc8aa2ac05878c28bfe412deddf16ed0083900e408723c11
MD5 974025704792c2021b20870620d02741
BLAKE2b-256 127ba8ea4c22a3a1de436cfc286e700ba2aa6e75a9a70642e5a1e8f54f424a1d

See more details on using hashes here.

Provenance

The following attestation bundles were made for copass_core-1.0.3-py3-none-any.whl:

Publisher: release-python.yml on olane-labs/copass

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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