Skip to main content

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.

screenshot

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

https://zenodo.org/badge/410108340.svg

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.

Metadata

Release files for trame-gwc 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for trame-gwc 0.2.1
File Size Uploaded Provenance Actions
trame_gwc-0.2.1.tar.gz 3.8 MB Without provenance Details for trame_gwc-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for trame-gwc 0.2.1
File Interpreter ABI Platform Actions
trame_gwc-0.2.1-py3-none-any.whl Python 3 none any Details for trame_gwc-0.2.1-py3-none-any.whl

Total release size: 7.5 MB

Release files / trame_gwc-0.2.1.tar.gz

Download URL trame_gwc-0.2.1.tar.gz
Size 3.8 MB
Tags Source
SHA-256 checksum
How to use checksums
5f17caff22e20504461c630473faad1165e3609a3a31027d4ed2c94ca4528eb1
BLAKE2b-256 checksum
How to use checksums
ae4867eebf33ffd61f4c472f71b79aaa2c81f1df775a58281c11c5a07e3c4fd0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / trame_gwc-0.2.1-py3-none-any.whl

Download URL trame_gwc-0.2.1-py3-none-any.whl
Size 3.8 MB
Tags Python 3
SHA-256 checksum
How to use checksums
e484d7262b65cf6bd5f02841ffed27b74647eaae5dd1f28f26946e10521a4892
BLAKE2b-256 checksum
How to use checksums
1ff674662acf204dbc96f2bbde20d1befc4d14f443fe7f171f0bf292ddb49f82
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.12

Security for trame-gwc 0.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page