Skip to main content

Internal client of trame

Project description

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

Uploaded Source

Built Distribution

trame_client-2.1.1-py3-none-any.whl (209.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame-client-2.1.1.tar.gz
  • Upload date:
  • Size: 203.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/35.0 requests/2.28.0 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.11.4 keyring/23.6.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.13

File hashes

Hashes for trame-client-2.1.1.tar.gz
Algorithm Hash digest
SHA256 5833dd99a6682543886b645ca3c3024745e7880a7e28c529751a7ad20da9b90a
MD5 1845c4df874980b6fd38c2eceb440589
BLAKE2b-256 8e3e11f1a48f3719be298c327cbe7a7ec30dcab2d15d21b52ef06a71e4db0c1e

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: trame_client-2.1.1-py3-none-any.whl
  • Upload date:
  • Size: 209.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.3 readme-renderer/35.0 requests/2.28.0 requests-toolbelt/0.9.1 urllib3/1.26.9 tqdm/4.64.0 importlib-metadata/4.11.4 keyring/23.6.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.9.13

File hashes

Hashes for trame_client-2.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ebf60f7a00799b9bce985531fa475fb76579bb7fb49bbfdc593c55f37a5d9938
MD5 0ebe3658547f4db92d5c189c50135619
BLAKE2b-256 96f0eebecf4f275c443b42939213917078f52657ebeb7edfcbe6052d30ea545b

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