Welcome to Trame Server’s documentation!

Trame Server is Trame’s server library.

Note

This project is under active development.

Usage

Installation

To use Trame Server, first install it using pip:

(.venv) $ pip install trame-server

Running

To create a server, you can instantiate a Server object:

class trame_server.Server(name='trame', vn_constructor=None, translator=None, parent_server=None, **options)

Server implementation for trame. This is the core object that manage client/server communication but also holds a state and controller instance. With trame a server instance should be retrieved by using trame.app.get_server()

Known options:

  • log_network: False (path to log file)

  • ws_max_msg_size: 10000000 (bytes)

  • ws_heart_beat: 30

  • desktop_debug: False

Parameters:

  • name (str, optional (default: trame)) – A name identifier for a given server

  • **options –

    Gather any keyword arguments into options

The name parameter can be used to specify the server name. For example:

>>> server = Server(name="my_server")
>>> server.name
'my_server'