Skip to main content

isA Common

Shared async Python client library for the isA platform.

Overview

isa-common provides async Python clients for interacting with isA Cloud infrastructure services. All clients use async with context managers and share a common base class (AsyncBaseClient).

Infrastructure Clients (require running services)

Client Service Default Port Protocol
AsyncRedisClient Redis 6379 gRPC proxy
AsyncPostgresClient PostgreSQL 5432 gRPC proxy
AsyncNeo4jClient Neo4j 7687 gRPC proxy
AsyncNATSClient NATS 4222 gRPC proxy
AsyncMQTTClient MQTT 1883 gRPC proxy
AsyncMinioClient MinIO 9000 gRPC proxy
AsyncQdrantClient Qdrant 6333 gRPC proxy
AsyncDuckDBClient DuckDB embedded native

Local-Mode Clients (no external services needed)

Drop-in alternatives for desktop/offline use. Same API surface, backed by local storage:

Local Client Replaces Backed By
AsyncSQLiteClient AsyncPostgresClient SQLite file
AsyncLocalStorageClient AsyncMinioClient Local filesystem
AsyncChromaClient AsyncQdrantClient ChromaDB (embedded)
AsyncMemoryClient AsyncRedisClient In-memory dict

When to use local clients: Use local-mode clients when running on desktop/ICP without cloud infrastructure, for development/testing without Docker, or when you need offline-capable storage.

Installation

pip install isa-common

Quick Start

from isa_common import AsyncRedisClient

async with AsyncRedisClient(host="localhost", port=6379, user_id="my-user") as client:
    health = await client.health_check()
    await client.set("key", "value")
    value = await client.get("key")

Using Local-Mode Clients

from isa_common import AsyncSQLiteClient, AsyncLocalStorageClient

# SQLite instead of PostgreSQL
async with AsyncSQLiteClient(database="app.db", user_id="my-user") as db:
    await db.query("SELECT * FROM users")

# Local filesystem instead of MinIO
async with AsyncLocalStorageClient(base_path="./storage", user_id="my-user") as storage:
    await storage.put_object("my-bucket", "file.txt", b"contents")

Development

Run tests (requires services or use local clients):

# Run individual service tests
python tests/redis/test_async_redis.py
python tests/duck/test_async_duckdb.py

# Run all tests via Makefile
make test

Contract Coverage

See tests/contract_coverage.md for the mapping between CDD contract IDs (BR/EC/ER) and test functions.

License

Copyright © 2024 isA Platform

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

isa_common-0.6.1.tar.gz (137.9 kB view details)

Uploaded Source

Built Distribution

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

isa_common-0.6.1-py3-none-any.whl (153.2 kB view details)

Uploaded Python 3

File details

Details for the file isa_common-0.6.1.tar.gz.

File metadata

  • Download URL: isa_common-0.6.1.tar.gz
  • Upload date:
  • Size: 137.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for isa_common-0.6.1.tar.gz
Algorithm Hash digest
SHA256 a6c4b2fec853e0db9fc8086bfbae91d2e5162f371432ee2154fa9d3a26fd5a6a
MD5 eeaa373f625cc1dda84aee14925345c0
BLAKE2b-256 e07787610d3d2847190e9f289e1143fdaf61aaa0b0228c2a1c9944e1d10ce529

See more details on using hashes here.

File details

Details for the file isa_common-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: isa_common-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 153.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for isa_common-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fdb7e44dcb58b185659f543832eb8d6640c5fd592375a67727eb6a33ee96f988
MD5 28a9962f194c70187a11fb839ff9596f
BLAKE2b-256 4d669d7b4a2a60529b0bafe42ab6e027f1be09f727b1500c8562f7e311f5b921

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