Skip to main content

Trame widget to expose xterm.js. This library is compatible with both vue2 and vue3.

License

This library is distributed under the MIT License (Same as xterm.js)

Usage Examples

Output terminal Multi-shell with python interpreter Interactive update with htop

Development setup

We recommend using uv for setting up and managing a virtual environment for your development.

# Create venv and install all dependencies
uv sync --all-extras --dev

# Activate environment
source .venv/bin/activate

# Install commit analysis
pre-commit install
pre-commit install --hook-type commit-msg

# Allow live code edit
uv pip install -e .

Build and install the Vue components

cd vue-components
npm i
npm run build
cd -

For running tests and checks, you can run nox.

# run all
nox

# lint
nox -s lint

# tests
nox -s tests

Professional Support

  • Training: Learn how to confidently use trame from the expert developers at Kitware.

  • Support: Our experts can assist your team as you build your web application and establish in-house expertise.

  • Custom Development: Leverage Kitware’s 25+ years of experience to quickly build your web application.

JavaScript dependency

This Python package bundle the xterm@5.1.0, xterm-theme@1.1.0 and xterm-addon-fit@0.7.0 JavaScript libraries. If you would like us to upgrade it, please reach out.

Metadata

Release files for trame-xterm 1.1.0

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-xterm 1.1.0
File Size Uploaded
trame_xterm-1.1.0.tar.gz 94.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for trame-xterm 1.1.0
File Interpreter ABI Platform
trame_xterm-1.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 192.0 kB

Release files / trame_xterm-1.1.0.tar.gz

Download URL trame_xterm-1.1.0.tar.gz
Size 94.7 kB
Tags Source
SHA-256 checksum
How to use checksums
eaebe34fe1d204474acba18a52a4ebe2229eb02ddd6aaa5ed6cf43ca723061a2
BLAKE2b-256 checksum
How to use checksums
8674ab2d581faf95701d8aba02b886f3f495790779b55973ea1aa6a647683319
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 14, 2026.

Transparency log

Release files / trame_xterm-1.1.0-py3-none-any.whl

Download URL trame_xterm-1.1.0-py3-none-any.whl
Size 97.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ffe9e507279fa107fed1362d5adaf6f17327dcc804a29d85b0bc214604c93510
BLAKE2b-256 checksum
How to use checksums
bdf9476c0875ea95bff099f58ccdec5a1185656a2f5521d4027e8b5f04f832e5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.7

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Mar 14, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

1.1.0 This release

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

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