Skip to main content

Internal server side implementation of trame

Project description

Test and Release

trame-server is the server implementation of trame. This Python library provide the server implementation of the shared state and controller along with the definition of the web server. The web server aims to be flexible so it can be use within a Jupyter environment or as a standalone desktop application.

This package is not supposed to be used by itself but rather should come as a dependency of trame. For any specificity, please refer to the trame documentation.

Installing

trame-server can be installed with pip:

pip install --upgrade trame-server

Usage

The Trame Tutorial is the place to go to learn how to use the library and start building your own application.

The API Reference documentation provides API-level documentation.

Environments variables

  • TRAME_LOG_NETWORK : Path to log file for capturing network exchange. (default: None)

  • TRAME_WS_MAX_MSG_SIZE : Maximum size in bytes of any ws message. (default: 10MB)

  • TRAME_WS_HEART_BEAT : Time in second before assuming the server is non-responsive. (default: 30s)

  • TRAME_DESKTOP_DEBUG : If defined it will allow user to inspect the web content in desktop mode

  • TRAME_SERVER : If set to true, this will prevent browser from opening by default

Life cycle callbacks

Life cycle events are directly managed on the application controller and are prefixed with on_*.

  • on_server_start : Executed at server.start() call while passing the server as argument.

  • on_server_bind : WSLinkServer is getting bound to trame so you can attach your own routes. Its instance will be passed as argument to callback.

  • on_server_ready : All protocols initialized and available for client to connect

  • on_client_connected : Connection established to server

  • on_client_exited : Linked to browser “beforeunload” event

  • on_server_exited : Trame is exiting its event loop

  • on_server_reload : If callback registered it can be use to hot_reload methods like the UI.

License

trame-server is made available under the Apache License, Version 2.0. For more details, see LICENSE

Community

Trame | Discussions | Issues | RoadMap | Contact Us

https://zenodo.org/badge/410108340.svg

Enjoying trame?

Share your experience with a testimonial or with a brand approval.

Project details


Download files

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

Source Distribution

trame-server-3.2.3.tar.gz (31.6 kB view details)

Uploaded Source

Built Distribution

trame_server-3.2.3-py3-none-any.whl (36.9 kB view details)

Uploaded Python 3

File details

Details for the file trame-server-3.2.3.tar.gz.

File metadata

  • Download URL: trame-server-3.2.3.tar.gz
  • Upload date:
  • Size: 31.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.11.1 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.66.5 importlib-metadata/8.5.0 keyring/25.4.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.15

File hashes

Hashes for trame-server-3.2.3.tar.gz
Algorithm Hash digest
SHA256 4b5d38c17f6c2e8a7bd4644a1d45e2bd79df9829c4ae24e987633754748311f2
MD5 5b14f40783127033b7987378d201e4ea
BLAKE2b-256 53a1b83dcbd5b107b1f7126824b9f2fb832cbdc0b12c18d26e1e733b52d8b8f2

See more details on using hashes here.

Provenance

File details

Details for the file trame_server-3.2.3-py3-none-any.whl.

File metadata

  • Download URL: trame_server-3.2.3-py3-none-any.whl
  • Upload date:
  • Size: 36.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.11.1 readme-renderer/44.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.3 tqdm/4.66.5 importlib-metadata/8.5.0 keyring/25.4.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.15

File hashes

Hashes for trame_server-3.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 40a8ca401893ec91e1ee09ccf674a75ce81a4695916e71412d74612ebd045d8f
MD5 60c808f02856fac83491db2607708187
BLAKE2b-256 b7e3e752e4afc66b924c615281265ecf233775860d133f95037af261b3dabd2b

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page