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-2.17.1.tar.gz (30.1 kB view details)

Uploaded Source

Built Distribution

trame_server-2.17.1-py3-none-any.whl (34.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame-server-2.17.1.tar.gz
  • Upload date:
  • Size: 30.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.2.0 tqdm/4.66.2 importlib-metadata/7.0.1 keyring/24.3.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.13

File hashes

Hashes for trame-server-2.17.1.tar.gz
Algorithm Hash digest
SHA256 0f062b8d5cabd08a0273a3d3e55d09b4ad2b8c0b47940921ed28247cfa9e81c4
MD5 b607a73eb24f0f2818946336bb5c1271
BLAKE2b-256 50dbb58fb7fc20e273a8a7c8ce024638b34c9ad3e92a2a7b7ec9905597daa53c

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: trame_server-2.17.1-py3-none-any.whl
  • Upload date:
  • Size: 34.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.6 readme-renderer/42.0 requests/2.31.0 requests-toolbelt/1.0.0 urllib3/2.2.0 tqdm/4.66.2 importlib-metadata/7.0.1 keyring/24.3.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.13

File hashes

Hashes for trame_server-2.17.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b87d06d005ccf8dba53b0565c217e856953dfe4de02aceea8b9a31c5ed0dad61
MD5 46e1a912ae800a963e1d867761d6e5b6
BLAKE2b-256 7f7febd2d749dce8db1f660b68935c83f5d42f1b076032753219b42ea078aae0

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