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

Uploaded Source

Built Distribution

trame_server-3.0.2-py3-none-any.whl (35.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame-server-3.0.2.tar.gz
  • Upload date:
  • Size: 30.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.11.1 readme-renderer/43.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.2 tqdm/4.66.4 importlib-metadata/7.1.0 keyring/25.2.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.14

File hashes

Hashes for trame-server-3.0.2.tar.gz
Algorithm Hash digest
SHA256 0bc57dc8e2771f84d790af8b85c2365aa14c81f6b9e5a61050a30d10050561db
MD5 07af4c465ba5061cebf9c69e3301430b
BLAKE2b-256 d1a016782253a8de736da5df9ac7c5644e8b72db9f24c71eefa51e0d16837c46

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: trame_server-3.0.2-py3-none-any.whl
  • Upload date:
  • Size: 35.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.11.1 readme-renderer/43.0 requests/2.32.3 requests-toolbelt/1.0.0 urllib3/2.2.2 tqdm/4.66.4 importlib-metadata/7.1.0 keyring/25.2.1 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.14

File hashes

Hashes for trame_server-3.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 dbd891d685a75d57b3794434bc3dd62fa5c97a35179a623f786973273d93ca74
MD5 7341fc4bffbef62c0a5282159ca81a2a
BLAKE2b-256 154918493a0baf793d91ec836d9c3dfd42dac3bdcf288d5a4a97d50b0b872933

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