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.2.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.2-py3-none-any.whl (42.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: copass_core-1.0.2.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.2.tar.gz
Algorithm Hash digest
SHA256 92ba8bc678fc6e15a1b589afa5a7ac969c17d8a2571d389e34b05926cd75ddb6
MD5 ae5393607b55a2233f6dd2ecaf984f01
BLAKE2b-256 2cddebb6d3fb458b55383db43bac1035b7af3c267ac551d778fa5707bbba3ce2

See more details on using hashes here.

Provenance

The following attestation bundles were made for copass_core-1.0.2.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.2-py3-none-any.whl.

File metadata

  • Download URL: copass_core-1.0.2-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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 7cf19330d159de4b9901df5293dcf3ea837eca2b0a72dd125266741d3fb0905f
MD5 e5381375eb2401d7dac03f01b867e44d
BLAKE2b-256 e2f6bfc181aa0df0a1ac0f31fdf24a96015d3956b8e2917a8e8ce5ceeab86d3a

See more details on using hashes here.

Provenance

The following attestation bundles were made for copass_core-1.0.2-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