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

Life cycle callbacks

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

  • 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 is use for reloading server side modules

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

Uploaded Source

Built Distribution

trame_server-2.6.0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame-server-2.6.0.tar.gz
  • Upload date:
  • Size: 18.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.2 readme-renderer/37.3 requests/2.28.1 requests-toolbelt/0.10.1 urllib3/1.26.13 tqdm/4.64.1 importlib-metadata/5.1.0 keyring/23.11.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.8

File hashes

Hashes for trame-server-2.6.0.tar.gz
Algorithm Hash digest
SHA256 a7ae7d7f5d16e86b156094ecd9e6e29e552e3cb1707132bf179174b3023f1c57
MD5 cc323ed2586eb8fface7eebda8c4fcf9
BLAKE2b-256 aaa7abc7424d8a5e3e5d09d526a4fa45a0b11f398c3778dad003b5edcb43503b

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: trame_server-2.6.0-py3-none-any.whl
  • Upload date:
  • Size: 21.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.9.2 readme-renderer/37.3 requests/2.28.1 requests-toolbelt/0.10.1 urllib3/1.26.13 tqdm/4.64.1 importlib-metadata/5.1.0 keyring/23.11.0 rfc3986/2.0.0 colorama/0.4.6 CPython/3.10.8

File hashes

Hashes for trame_server-2.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0489296eaa5ccfd9f1b8ed44843e2e5ef1a3acb2093cf5535d5aa0f7cfbc8971
MD5 9a70c09ae71ddd3445015f30c6b5c15f
BLAKE2b-256 f74ca1f09bb1a6d8581f899a356648545d2fd5f141e7b23300ecc5fbb4cc56a6

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