https://github.com/kitware/trame-xterm
XTerm widget for trame
https://github.com/kitware/trame-xterm
trame trame-maintenance-program
Last synced: 3 months ago
JSON representation
XTerm widget for trame
- Host: GitHub
- URL: https://github.com/kitware/trame-xterm
- Owner: Kitware
- License: mit
- Created: 2023-04-05T22:02:54.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-09T21:20:48.000Z (over 1 year ago)
- Last Synced: 2025-11-11T03:28:24.945Z (7 months ago)
- Topics: trame, trame-maintenance-program
- Language: Python
- Homepage:
- Size: 2.41 MB
- Stars: 1
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.rst
- License: LICENSE
Awesome Lists containing this project
README
.. |pypi_download| image:: https://img.shields.io/pypi/dm/trame-xterm
trame-xterm |pypi_download|
===========================================================
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
-----------------------------------------------------------
.. image:: examples/xterm-output.png
:alt: Output terminal
.. image:: examples/xterm-multi.png
:alt: Multi-shell with python interpreter
.. image:: examples/xterm-interactive.png
:alt: Interactive update with htop
Development setup
----------------------------------------
We recommend using uv for setting up and managing a virtual environment for your development.
.. code-block:: console
# 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
.. code-block:: console
cd vue-components
npm i
npm run build
cd -
For running tests and checks, you can run ``nox``.
.. code-block:: console
# 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 `_.