trame-client: core client for trame
===========================================================================
.. image:: https://github.com/Kitware/trame-client/actions/workflows/test_and_release.yml/badge.svg
:target: https://github.com/Kitware/trame-client/actions/workflows/test_and_release.yml
:alt: Test and Release
trame-client is the generic single page application that come with `trame <https://kitware.github.io/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 <https://kitware.github.io/trame/>`_.
Installing
-----------------------------------------------------------
trame-client can be installed with `pip <https://pypi.org/project/trame-client/>`_:
.. code-block:: bash
pip install --upgrade trame-client
Usage
-----------------------------------------------------------
The `Trame Tutorial <https://kitware.github.io/trame/docs/tutorial.html>`_ is the place to go to learn how to use the library and start building your own application.
The `API Reference <https://trame.readthedocs.io/en/latest/index.html>`_ documentation provides API-level documentation.
License
-----------------------------------------------------------
trame-client is made available under the MIT License. For more details, see `LICENSE <https://github.com/Kitware/trame-client/blob/master/LICENSE>`_
This license has been chosen to match the one use by `Vue.js <https://github.com/vuejs/vue/blob/dev/LICENSE>`_ which is instrumental for making that library possible.
Community
-----------------------------------------------------------
`Trame <https://kitware.github.io/trame/>`_ | `Discussions <https://github.com/Kitware/trame/discussions>`_ | `Issues <https://github.com/Kitware/trame/issues>`_ | `RoadMap <https://github.com/Kitware/trame/projects/1>`_ | `Contact Us <https://www.kitware.com/contact-us/>`_
.. image:: https://zenodo.org/badge/410108340.svg
:target: https://zenodo.org/badge/latestdoi/410108340
Enjoying trame?
-----------------------------------------------------------
Share your experience `with a testimonial <https://github.com/Kitware/trame/issues/18>`_ or `with a brand approval <https://github.com/Kitware/trame/issues/19>`_.
Development
-----------------------------------------------------------
Build client side code base
.. code-block:: console
cd vue[2,3]-app
npm install
npm run build # build trame client application
cd -
Raw data
{
"_id": null,
"home_page": null,
"name": "trame-client",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Python, Interactive, Web, Application, Framework",
"author": "Kitware Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/02/82/714db035e0bcd349da7941a4a2c4c4d53d620af5db4739ceca50839e2f13/trame-client-3.0.2.tar.gz",
"platform": null,
"description": "trame-client: core client for trame\n===========================================================================\n\n.. image:: https://github.com/Kitware/trame-client/actions/workflows/test_and_release.yml/badge.svg\n :target: https://github.com/Kitware/trame-client/actions/workflows/test_and_release.yml\n :alt: Test and Release\n\ntrame-client is the generic single page application that come with `trame <https://kitware.github.io/trame/>`_.\ntrame-client provides the infrastructure on the client-side (browser) to connect to a trame server, synchronize\nits state with the server, make method call, load dynamically components and feed a dynamic template provided by the server.\n\nThis package is not supposed to be used by itself but rather should come as a dependency of **trame**.\nFor any specificity, please refer to `the trame documentation <https://kitware.github.io/trame/>`_.\n\n\nInstalling\n-----------------------------------------------------------\n\ntrame-client can be installed with `pip <https://pypi.org/project/trame-client/>`_:\n\n.. code-block:: bash\n\n pip install --upgrade trame-client\n\n\nUsage\n-----------------------------------------------------------\n\nThe `Trame Tutorial <https://kitware.github.io/trame/docs/tutorial.html>`_ is the place to go to learn how to use the library and start building your own application.\n\nThe `API Reference <https://trame.readthedocs.io/en/latest/index.html>`_ documentation provides API-level documentation.\n\nLicense\n-----------------------------------------------------------\n\ntrame-client is made available under the MIT License. For more details, see `LICENSE <https://github.com/Kitware/trame-client/blob/master/LICENSE>`_\nThis license has been chosen to match the one use by `Vue.js <https://github.com/vuejs/vue/blob/dev/LICENSE>`_ which is instrumental for making that library possible.\n\n\nCommunity\n-----------------------------------------------------------\n\n`Trame <https://kitware.github.io/trame/>`_ | `Discussions <https://github.com/Kitware/trame/discussions>`_ | `Issues <https://github.com/Kitware/trame/issues>`_ | `RoadMap <https://github.com/Kitware/trame/projects/1>`_ | `Contact Us <https://www.kitware.com/contact-us/>`_\n\n.. image:: https://zenodo.org/badge/410108340.svg\n :target: https://zenodo.org/badge/latestdoi/410108340\n\n\nEnjoying trame?\n-----------------------------------------------------------\n\nShare your experience `with a testimonial <https://github.com/Kitware/trame/issues/18>`_ or `with a brand approval <https://github.com/Kitware/trame/issues/19>`_.\n\n\nDevelopment\n-----------------------------------------------------------\n\nBuild client side code base\n\n.. code-block:: console\n\n cd vue[2,3]-app\n npm install\n npm run build # build trame client application\n cd -\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Internal client of trame",
"version": "3.0.2",
"project_urls": null,
"split_keywords": [
"python",
" interactive",
" web",
" application",
" framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "64e92327a1eed245cebe78377bcc6ddf3398040bdd8d3afeb5cff2de521cb449",
"md5": "9962b18596f555786384cd6b2901bcff",
"sha256": "0356fd302d16a86bf0ee2ff6bb10969555fbfb772e23595f4040a94da1810bb9"
},
"downloads": -1,
"filename": "trame_client-3.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9962b18596f555786384cd6b2901bcff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 230973,
"upload_time": "2024-04-17T20:44:09",
"upload_time_iso_8601": "2024-04-17T20:44:09.253346Z",
"url": "https://files.pythonhosted.org/packages/64/e9/2327a1eed245cebe78377bcc6ddf3398040bdd8d3afeb5cff2de521cb449/trame_client-3.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0282714db035e0bcd349da7941a4a2c4c4d53d620af5db4739ceca50839e2f13",
"md5": "1bdeeda011f7c484f305b00d9fd3ff13",
"sha256": "19e33e2ac9b842b59ee04d9fdb4003d76eb6a592c8ccef4c5f0ff903552fdc37"
},
"downloads": -1,
"filename": "trame-client-3.0.2.tar.gz",
"has_sig": false,
"md5_digest": "1bdeeda011f7c484f305b00d9fd3ff13",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 225148,
"upload_time": "2024-04-17T20:44:13",
"upload_time_iso_8601": "2024-04-17T20:44:13.314907Z",
"url": "https://files.pythonhosted.org/packages/02/82/714db035e0bcd349da7941a4a2c4c4d53d620af5db4739ceca50839e2f13/trame-client-3.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-17 20:44:13",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "trame-client"
}
JSON