Skip to main content

Internal server side implementation of trame

Project description

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_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.0.0rc6.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

trame_server-2.0.0rc6-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file trame-server-2.0.0rc6.tar.gz.

File metadata

  • Download URL: trame-server-2.0.0rc6.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for trame-server-2.0.0rc6.tar.gz
Algorithm Hash digest
SHA256 e294081aaf96a58d903e3057dcebaea050127a69e897d6781f8cf9fb7479fac8
MD5 8ef6f51be46e32959845a975444fd06c
BLAKE2b-256 5eeb451393d39c01d6ab3528176dc668fa0a6acf087a2c0a028ccfce9c74bd17

See more details on using hashes here.

Provenance

File details

Details for the file trame_server-2.0.0rc6-py3-none-any.whl.

File metadata

  • Download URL: trame_server-2.0.0rc6-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.10.1 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.7

File hashes

Hashes for trame_server-2.0.0rc6-py3-none-any.whl
Algorithm Hash digest
SHA256 b34cd71457f53e710c8fadb3c959ca1d9c6dcb035be91b1738decf060a5fd285
MD5 d80ccfadadd1dd73fea620ca05308677
BLAKE2b-256 8d84cac585b3800645ba60033ef6634bf2c92ae79993f64e1a61fa605f6e1935

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