trame-gwc 0.2.1

Trame wrapper to girder_web_components

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 | 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
pnpm i
pnpm run build
cd ..

Install the application for development

pip install -e .

Examples

This repository includes several example applications demonstrating how to use Girder Web Components with trame.

The examples use data.kitware.com as the default Girder instance.

Available examples

Showcase demo

The showcase/app.py application is a lightweight demonstration of the available Girder Web Components and their integration with trame. It is inspired by the official Girder Web Components demo app.

File Browser example

The file_browser/app.py application shows how to build a more structured trame application around Girder. It demonstrates how to:

• browse the Girder database

• parse collections and folders

• manage authentication

• download files (using the girder client)

Run the examples

pip install ".[examples]"

# Run the basic demo
python examples/showcase/app.py

# Run the advanced example
python examples/file_browser/app.py

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.