Skip to main content

Internal client of trame

Project description

Test and Release

trame-client is the generic single page application that come with trame. trame-client provides the infrastructure on the client-side (browser) to connect to a trame server, synchronize its state with the server, make method call, load dynamically components and feed a dynamic template provided by the server.

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-client can be installed with pip:

pip install --upgrade trame-client

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.

This library specifically brings the following set of vue.js components to the core client side application. They will be available as a library on NPM to support trame integration into existing vue.js based application.

<trame-connect name="TrameConnect" :config="{}" :exclude="[]" use-url forward-errors>
    <trame-server-template template-name="main" />

    <trame-loading message="welcome" />

    <trame-state-resolver :names="['a', 'b', 'c']" v-slot="{a, b, c, set, trame}">
        <div>
            <div>
                A: {{ a }}
            </div>
            <div>
                B: {{ b }}
            </div>
            <div>
                C: {{ c }}
            </div>
            <br>
            <button @click="trame.state.set('a', a + 1)">A+</button>
            <br>
            <button @click="set('a', a - 1)">A-</button>
            <br>
            <button>B</button>
            <br>
            <button>C</button>
        </div>
    </trame-state-resolver>
</trame-connect>

License

trame-client is made available under the MIT License. For more details, see LICENSE This license has been chosen to match the one use by Vue.js which is instrumental for making that library possible.

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.

Development

Build client side code base

cd vue-app
npm i
npm run build            # build trame client application
npm run build:components # build trame components for integration purpose
cd -

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

trame-client-2.3.6.tar.gz (224.6 kB view details)

Uploaded Source

Built Distribution

trame_client-2.3.6-py3-none-any.whl (231.0 kB view details)

Uploaded Python 3

File details

Details for the file trame-client-2.3.6.tar.gz.

File metadata

  • Download URL: trame-client-2.3.6.tar.gz
  • Upload date:
  • Size: 224.6 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.9

File hashes

Hashes for trame-client-2.3.6.tar.gz
Algorithm Hash digest
SHA256 572393544464de7d47b930fe46c48ad9a2d8a60944fea74e7ac281ddf9bf0536
MD5 a0b74fd8ff0d9a33d9b58791261c821d
BLAKE2b-256 aefb1a1addf3533b46088b5edaf7d2527bee8411b386307603bcdec97740e2a4

See more details on using hashes here.

Provenance

File details

Details for the file trame_client-2.3.6-py3-none-any.whl.

File metadata

  • Download URL: trame_client-2.3.6-py3-none-any.whl
  • Upload date:
  • Size: 231.0 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.9

File hashes

Hashes for trame_client-2.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0d18ae5d97f43af851162d9af52f52395d4f3735eca8183a7bb82988e61cbd9b
MD5 f42b90f7803e9dff72dc89c14a5298ea
BLAKE2b-256 b9b6d7fcb3fadc9d59abee36f4d9a429b426871150c25344772ab68c5029685c

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