Metadata-Version: 2.4
Name: btwebterminal
Version: 2.9.0
Summary: Webterminal Component for Bert's Interactive Lesson Loader
Home-page: https://github.com/berttejeda/bert.webterminal
Author: Engelbert Tejeda
Author-email: berttejeda@gmail.com
Keywords: browser-based,webterminal,xtermjs
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.7
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: terminado<1.0.0,>=0.12.0
Requires-Dist: coloredlogs
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: coveralls; extra == "tests"
Requires-Dist: flake8; extra == "tests"
Requires-Dist: mypy; extra == "tests"

# Overview

This is the Webterminal agent to be used with various projects I've developed, e.g.

- [bert.dashboard](https://github.com/berttejeda/bert.dashboard)
- [bert.bill](https://github.com/berttejeda/bert.bill) (superceded by above)
- [bert.slidev - webterminal addon](https://github.com/berttejeda/bert.slidev)

This agent allows the app's [xtermjs]((https://github.com/xtermjs/xterm.js/)) Webterminal React component to connect \
to a local bash process on your computer.

You can get this Webterminal agent running either by:

- Running the pre-built docker image:
  ```shell
  docker run -it --name webterminal --rm -p 10001:10001 berttejeda/bill-webterminal
  ```
- Running `docker-compose up -d` from this project
- Install btdashboard with `pip install btdashboard` and running `btdashboard`, OR \
  Cloning the [berttejeda/bert.dashboard](https://github.com/berttejeda/bert.dashboard) project, installing all requirements, and \
  running `python btdashboard/app.py -aio` \
  Doing so will launch a local websocket that forwards keystrokes to a bash process on your system
- Install bertdotbill with `pip install bertdotbill` and running `bill -aio`, OR \
  Cloning the [bert.bill](https://github.com/berttejeda/bert.bill) project, installing all requirements, and \
  running `python bertdotbill/app.py -aio` \
  Doing so will launch a local websocket that forwards keystrokes to a bash process on your system

Either of the commands above will start the websocket and bash process on localhost:10001, \
but you can change the port if you like.

You can then connect to the agent through the Web UI.

# Architecture

- Utilizes [spyder-terminal](https://github.com/spyder-ide/spyder-terminal) component

# Features

- You can practice the lesson material with your own OS/system
- Simply **click** on a command, and it will be sent and executed on the underlying shell via web terminal!
- Default shell is bash (for now)
