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.0rc8.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

trame_server-2.0.0rc8-py3-none-any.whl (18.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame-server-2.0.0rc8.tar.gz
  • Upload date:
  • Size: 16.1 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.0rc8.tar.gz
Algorithm Hash digest
SHA256 f85a9a5fb264a92491e0667fba50cdc166dbb007053422c87c6618689c21055b
MD5 fe8e893267af4c155c471d286f35e3d2
BLAKE2b-256 2ec8603be74ebbbc23d656bbcd1ed8644baaea04ef6e26f9eac395fcf65fe0ba

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: trame_server-2.0.0rc8-py3-none-any.whl
  • Upload date:
  • Size: 18.7 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.0rc8-py3-none-any.whl
Algorithm Hash digest
SHA256 b8a641bd93cb719e61f18adc0bc1c0ed1755e37b1b4d720d860e78a61175ffd9
MD5 f0b5ad6c26eb1f75428f20a553247955
BLAKE2b-256 1c1966044157638582204e3e5cd4098274e31736387323b798f1ffac344a6c0e

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