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

This version

2.3.2

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

Uploaded Source

Built Distribution

trame_client-2.3.2-py3-none-any.whl (230.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: trame-client-2.3.2.tar.gz
  • Upload date:
  • Size: 223.8 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.8

File hashes

Hashes for trame-client-2.3.2.tar.gz
Algorithm Hash digest
SHA256 42803eb5233bf9353c10a03da35f82047b4d01991e44f7c919e2234f6e182216
MD5 98d8021df8c5e92f14e3831bc7219c89
BLAKE2b-256 2820db01a6254d1e16ef9479eae717cb0695875722c5c0bd1dd9492dc5de7eac

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: trame_client-2.3.2-py3-none-any.whl
  • Upload date:
  • Size: 230.2 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.8

File hashes

Hashes for trame_client-2.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c35ed20582cbb7225526fd08103d1c4b77e0a322f65057d5407f61beb1cac262
MD5 ecef52a28074b53f3bc16bf8fdc64b71
BLAKE2b-256 14a6f0e416c31ead0ae3679fcc9ad9f913c51bf0eb8e903441a9f7d3d444f836

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