Module explosig_connect

Browse git

Sub-modules

explosig_connect.connection

Functions

def connect(session_id=None, empty=False, password=None, server_hostname='https://explosig-server.lrgr.io', client_hostname='https://explosig.lrgr.io', how='auto')

Connect to an ExploSig session.

Parameters

session_id : str, optional
An ExploSig session ID. If not provided, a new "empty" session will be started. by default None
empty : bool, optional
If True, will open an "empty" session regardless of whether session_id is provided. by default False
password : str, optional
Required if not using the public instance of ExploSig and instead using a password-protected instance. by default None
server_hostname : str, optional
Use to specify an alternate ExploSig server instance. by default 'https://explosig-server.lrgr.io'
client_hostname : str, optional
Use to specify an alternate ExploSig client instance. by default 'https://explosig.lrgr.io'
how : str, optional
If starting a new empty session, the method for opening in the browser, passed to EmptyConnection.open(). by default 'auto'

Returns

Connection Returns an object of a Connection subclass: EmptyConnection if starting a new "empty" session, or ConfigConnection if connecting to an existing session that has been configured and started from within ExploSig.

Browse git