Python API

An overview of the Hub API to get you going with Hub

Hub classes

Hub([connection_parameters])	Provides access to communicate with an instance of a running Cegal Hub Server.
AgentContext(hub_client, wellknown_connector_id)	A context or handle to a Cegal Hub Agent or Agents.
PetrelContext(hub_client, wellknown_connector_id)	A context or handle to a Cegal Hub Petrel Connector(s).
ConnectionParameters([host, port, use_tls, ...])	The connection parameters for communicating with a Cegal Hub Server.
ConnectorFilter([target_connector_id, ...])	A filter to target a particular instance of a Connector that is joined to Cegal Hub Server.
ClientConfig()	Global configuration for the Python client communicating with a running Cegal Hub Server.
ServerConfig()	The global Hub Server configuration for communicating with a Cegal Hub Server.
BaseContext(hub_client, wellknown_connector_id)	A Base Context typically extended by another class which will contain some utility methods to communicate with a specific Connector type
HubClient([connection_parameters, ...])	A convenience utility class for making GRPC unary, client and server streaming requests to Cegal Hub Connectors via a running Cegal Hub Server.
HubChannel([connection_parameters, ...])	A Cegal Hub configured GRPC channel for use with a Cegal Hub Server.