Girder Web Components for trame
==================================
trame-gwc extend trame **widgets** with components that can be used to authenticate to girder and to manage files, jobs and accesses.
It leverages `girder_web_components <https://github.com/girder/girder_web_components>`_.
|screenshot|
Installing
-----------------------------------------------------------
trame-gwc can be installed with `pip <https://pypi.org/project/trame-gwc/>`_:
.. code-block:: bash
pip install --upgrade trame-gwc
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-gwc is made available under the Apache License.
For more details, see `LICENSE <https://github.com/Kitware/trame-gwc/blob/master/LICENSE>`_. This license has been chosen to match the one use by `girder_web_components <https://github.com/girder/girder_web_components>` which can be exposed via this library.
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 and install the Vue components (see `vue-components/README.md <https://github.com/Kitware/trame-gwc/blob/master/vue-components/README.md>`_)
.. code-block:: console
cd vue-components
npm i
npm run build
cd -
Install the application for development
.. code-block:: console
pip install -e .
Example
-----------------------------------------------------------
Try the `demo app <https://github.com/Kitware/trame-gwc/blob/master/examples/demo.py>`_. The default Girder API is `data.kitware.com <https://data.kitware.com/>`_.
An external Girder API can be used either by changing the TRAME_APP_API_ROOT environment variable or by disconnecting and providing the API root directly in the demo app.
.. code-block:: console
python examples/demo.py
.. |screenshot| image:: examples/screenshots/demo.png
JavaScript dependency
-----------------------------------------------------------
This Python package bundle the ``@girder/components@3.2.0`` JavaScript library. If you would like us to upgrade it, `please reach out <https://www.kitware.com/trame/>`_.
Raw data
{
"_id": null,
"home_page": null,
"name": "trame-gwc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "Python, Interactive, Web, Application, Framework",
"author": "Kitware Inc.",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/c0/e0/ebbc5830108e5c4d702f73376900758e2469ca60edec20f69e40795e7344/trame_gwc-0.1.0.tar.gz",
"platform": null,
"description": "Girder Web Components for trame\n==================================\n\ntrame-gwc extend trame **widgets** with components that can be used to authenticate to girder and to manage files, jobs and accesses.\nIt leverages `girder_web_components <https://github.com/girder/girder_web_components>`_.\n\n|screenshot|\n\nInstalling\n-----------------------------------------------------------\n\ntrame-gwc can be installed with `pip <https://pypi.org/project/trame-gwc/>`_:\n\n.. code-block:: bash\n\n pip install --upgrade trame-gwc\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\n\nLicense\n-----------------------------------------------------------\n\ntrame-gwc is made available under the Apache License.\nFor more details, see `LICENSE <https://github.com/Kitware/trame-gwc/blob/master/LICENSE>`_. This license has been chosen to match the one use by `girder_web_components <https://github.com/girder/girder_web_components>` which can be exposed via this library.\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 and install the Vue components (see `vue-components/README.md <https://github.com/Kitware/trame-gwc/blob/master/vue-components/README.md>`_)\n\n.. code-block:: console\n\n cd vue-components\n npm i\n npm run build\n cd -\n\nInstall the application for development\n\n.. code-block:: console\n\n pip install -e .\n\nExample\n-----------------------------------------------------------\n\nTry the `demo app <https://github.com/Kitware/trame-gwc/blob/master/examples/demo.py>`_. The default Girder API is `data.kitware.com <https://data.kitware.com/>`_.\nAn external Girder API can be used either by changing the TRAME_APP_API_ROOT environment variable or by disconnecting and providing the API root directly in the demo app.\n\n.. code-block:: console\n\n python examples/demo.py\n\n.. |screenshot| image:: examples/screenshots/demo.png\n\n\nJavaScript dependency\n-----------------------------------------------------------\n\nThis Python package bundle the ``@girder/components@3.2.0`` JavaScript library. If you would like us to upgrade it, `please reach out <https://www.kitware.com/trame/>`_.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Trame wrapper to girder_web_components",
"version": "0.1.0",
"project_urls": null,
"split_keywords": [
"python",
" interactive",
" web",
" application",
" framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6bfffe87692e1a23484dbfa60b543508ef334351e5dcc4ab9ae9933c65098f74",
"md5": "4a0bca4fa7fb3b1a7bf8ab6d9f2144f6",
"sha256": "90ffbcc6b14599b7b79795aaac91edbf3a9cbad27826033b7d2e180de04b1c6d"
},
"downloads": -1,
"filename": "trame_gwc-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4a0bca4fa7fb3b1a7bf8ab6d9f2144f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 4028995,
"upload_time": "2025-01-23T14:10:36",
"upload_time_iso_8601": "2025-01-23T14:10:36.097235Z",
"url": "https://files.pythonhosted.org/packages/6b/ff/fe87692e1a23484dbfa60b543508ef334351e5dcc4ab9ae9933c65098f74/trame_gwc-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c0e0ebbc5830108e5c4d702f73376900758e2469ca60edec20f69e40795e7344",
"md5": "e7564e063f6fa22ad49cdc78d9d12090",
"sha256": "4f205b295b2db73a79038ef2c69ea2625bbd6c993313069d28fc57fc1fac68ce"
},
"downloads": -1,
"filename": "trame_gwc-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "e7564e063f6fa22ad49cdc78d9d12090",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4024473,
"upload_time": "2025-01-23T14:10:38",
"upload_time_iso_8601": "2025-01-23T14:10:38.947590Z",
"url": "https://files.pythonhosted.org/packages/c0/e0/ebbc5830108e5c4d702f73376900758e2469ca60edec20f69e40795e7344/trame_gwc-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-23 14:10:38",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "trame-gwc"
}
JSON