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

Uploaded Source

Built Distribution

trame_client-2.2.2-py3-none-any.whl (229.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame-client-2.2.2.tar.gz
  • Upload date:
  • Size: 223.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.2 requests/2.28.1 requests-toolbelt/0.10.0 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/5.0.0 keyring/23.9.3 rfc3986/2.0.0 colorama/0.4.5 CPython/3.9.15

File hashes

Hashes for trame-client-2.2.2.tar.gz
Algorithm Hash digest
SHA256 82c1e4ade93f84257a4571ea6e1d2dd652f3789e7c42a341429b7383ec2767f6
MD5 f98972c7eba25546e614bab4f1a89a62
BLAKE2b-256 ce414a0c624167dc9a97587fdeefec6c2b94ac930cc2474bb0b10f9530e2aebe

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: trame_client-2.2.2-py3-none-any.whl
  • Upload date:
  • Size: 229.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/37.2 requests/2.28.1 requests-toolbelt/0.10.0 urllib3/1.26.12 tqdm/4.64.1 importlib-metadata/5.0.0 keyring/23.9.3 rfc3986/2.0.0 colorama/0.4.5 CPython/3.9.15

File hashes

Hashes for trame_client-2.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 93873f2a5c77f85b36a25a462433ca34b37c28eab01335997fb82c83c1b03192
MD5 04e03abe8050e0319e4297edd26bfdb5
BLAKE2b-256 c260f0dbdf0c0602dfb6321c230ba0f68510749521c37e5f29fa7c2dacb53b2a

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