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.

Installing

trame-gwc can be installed with pip:

pip install --upgrade trame-gwc

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.

License

trame-gwc is made available under the Apache License. For more details, see 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 | Discussions | Issues | RoadMap | Contact Us

Enjoying trame?

Share your experience with a testimonial or with a brand approval.

Development

Build and install the Vue components (see vue-components/README.md)

cd vue-components
npm i
npm run build
cd -

Install the application for development

pip install -e .

Example

Try the demo app. The default Girder API is 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.

python examples/demo.py