interactive terminal in the browser
Project description
pyxterm.js
A fully functional terminal in your browser.
How does this work?
On the backend:
- A Flask server is running
- The Flask server uses flask-socketio, a websocket library for Flask and socketio
- A pty ("pseudo-terminal") is spawned that runs bash.
- You can think of a pty as a way to serialize/deserialize a terminal session. The Python docs describe it as "starting another process and being able to write to and read from its controlling terminal programmatically".
On the frontend:
- Xterm.js is used to render Xterm output data in the browser.
- This means escape codes used by terminals to control the cursor location, color, and other options can be passed directly to Xterm.js and Xterm.js will faithfully render them as a terminal would.
- Output from the pty process on the backend is fed into it.
- Input from the browser is passed via websocket to the pty's input
Why?
The real purpose of this is to show a basic proof of concept on how to bring Xterm.js, Python, Flask, and Websockets together to run a pty in the browser.
This is a
- starting point to build your own web app with a terminal
- learning tool to understand what a
pty
is, and how to use one in Python - way to see Flask and Flask-SocketIO in action
- way to play around with Xterm.js in a meaningful environment
Installation
There are a few ways to install and run.
Clone & Run Locally
Clone this repository, enter the pyxtermjs
directory.
If you have nox you can run the following.
> nox -s run
Nox takes care of setting up a virtual environment and running the right command for you. You can pass arguments to the server like this
> nox -s run -- --debug
If you don't have nox, you can run the following from inside a virtual environment.
> pip install -r requirements.txt
> python -m pyxtermjs
> python -m pyxtermjs --debug
Install
You can install with pipx (recommended) or pip.
> pipx install pyxtermjs
> pyxtermjs
Or you can try run latest version on PyPI
> pipx run pyxtermjs
API
> pyxtermjs --help
usage: pyxtermjs [-h] [-p PORT] [--host HOST] [--debug] [--version]
[--command COMMAND] [--cmd-args CMD_ARGS]
A fully functional terminal in your browser.
https://github.com/cs01/pyxterm.js
optional arguments:
-h, --help show this help message and exit
-p PORT, --port PORT port to run server on (default: 5000)
--host HOST host to run server on (use 0.0.0.0 to allow access
from other hosts) (default: 127.0.0.1)
--debug debug the server (default: False)
--version print version and exit (default: False)
--command COMMAND Command to run in the terminal (default: bash)
--cmd-args CMD_ARGS arguments to pass to command (i.e. --cmd-args='arg1
arg2 --flag') (default: )
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file pyxtermjs-0.5.0.0.tar.gz
.
File metadata
- Download URL: pyxtermjs-0.5.0.0.tar.gz
- Upload date:
- Size: 7.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c47d9a575eb60f13f65599b9fc152bf6fbe9bd9701a3bd19e721097410655fc9 |
|
MD5 | bc89c4fc694a81d7c9849b33a8c91e52 |
|
BLAKE2b-256 | 53e9ff0020f2c75d0a5c15906ea11fac6f10e81a4a4f91b741dd5fffff84ee12 |
File details
Details for the file pyxtermjs-0.5.0.0-py3-none-any.whl
.
File metadata
- Download URL: pyxtermjs-0.5.0.0-py3-none-any.whl
- Upload date:
- Size: 7.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.6.3 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.0 CPython/3.8.9
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8f1b0e93e05a8753fe8caa3bca864c6c9c534591ffb2fb56451080bf83bbf288 |
|
MD5 | 08e48290a2bc577e63f56c5d3a188a1b |
|
BLAKE2b-256 | 721c13b7786e27c4c55232fc33bb61073bad0ade6fa066633b2f7c76f09267d1 |