pyami-3forge 1.5.4

Universal Python client for 3forge AMI — JDBC, Real-Time, and Center protocols with SSL support

pyami

Python package for accessing 3forge AMI databases.

This repository contains a few different “layers” you can use depending on how you like to work:

• pyami.rt.ami_client: compiled nanobind extension — real-time messaging client (RT, Center, JDBC). See src/pyami/cpp/README.md.
• pyami.db.ami_dbapi: DB-API 2.0 (PEP 249) interface built on top of ami_client. See src/pyami/db/ami_dbapi/README.md.
• pyami.db.sqlalchemy_ami: SQLAlchemy dialect. See src/pyami/db/sqlalchemy_ami/README.md.
• pyami.pyjdbc: pure-Python JDBC wire-protocol client. See src/pyami/pyjdbc/README.md.

All connection types (RT, Center, JDBC) support automatic failover and sharding:

• Failover — configure one or more backup endpoints per protocol and the client reconnects transparently on disconnect.
• Sharding — each protocol can hold a vector of independent shards. By default there is one shard (and the API matches the original single-server shape). Adding more shards lets a single cluster span multiple servers, with an optional per-protocol distribution function deciding which shards a publish or write goes to.

See the Failover endpoints and Sharding sections of the user guide.

Guides

• docs/user_guide.md — full API walkthrough across all layers.
• docs/jupyter_user_guide.md — using the AMI client in Jupyter notebooks (DataFrames, live Panel dashboards, callback threading).
• docs/sqlalchemy_user_guide.md — the SQLAlchemy ami+jdbc:// dialect (Core, ORM, DDL/indexes, reflection, pandas).
• docs/build_packaging.md — how the package is built, published, and installed.