Tornado websocket backend for the Xterm.js Javascript terminal emulator library.
Project description
Terminado
This is a Tornado websocket backend for the Xterm.js Javascript terminal emulator library.
It evolved out of pyxterm, which was part of GraphTerm (as lineterm.py), v0.57.0 (2014-07-18), and ultimately derived from the public-domain Ajaxterm code, v0.11 (2008-11-13) (also on Github as part of QWeb).
Modules:
terminado.management: controls launching virtual terminals, connecting them to Tornado's event loop, and closing them down.terminado.websocket: Provides a websocket handler for communicating with a terminal.terminado.uimodule: Provides aTerminalTornado UI Module.
JS:
terminado/_static/terminado.js: A lightweight wrapper to set up a term.js terminal with a websocket.
Local Installation:
$ pip install -e .[test]
Usage example:
import os.path
import tornado.web
import tornado.ioloop
# This demo requires tornado_xstatic and XStatic-term.js
import tornado_xstatic
import terminado
STATIC_DIR = os.path.join(os.path.dirname(terminado.__file__), "_static")
class TerminalPageHandler(tornado.web.RequestHandler):
def get(self):
return self.render(
"termpage.html",
static=self.static_url,
xstatic=self.application.settings["xstatic_url"],
ws_url_path="/websocket",
)
if __name__ == "__main__":
term_manager = terminado.SingleTermManager(shell_command=["bash"])
handlers = [
(r"/websocket", terminado.TermSocket, {"term_manager": term_manager}),
(r"/", TerminalPageHandler),
(
r"/xstatic/(.*)",
tornado_xstatic.XStaticFileHandler,
{"allowed_modules": ["termjs"]},
),
]
app = tornado.web.Application(
handlers,
static_path=STATIC_DIR,
xstatic_url=tornado_xstatic.url_maker("/xstatic/"),
)
# Serve at http://localhost:8765/ N.B. Leaving out 'localhost' here will
# work, but it will listen on the public network interface as well.
# Given what terminado does, that would be rather a security hole.
app.listen(8765, "localhost")
try:
tornado.ioloop.IOLoop.instance().start()
finally:
term_manager.shutdown()
See the demos
directory for
more examples. This is a simplified version of the single.py demo.
Run the unit tests with:
$ pytest
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 terminado-0.18.0.tar.gz.
File metadata
- Download URL: terminado-0.18.0.tar.gz
- Upload date:
- Size: 32.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1ea08a89b835dd1b8c0c900d92848147cef2537243361b2e3f4dc15df9b6fded |
|
| MD5 | 30c6e8e61041582724be06f387130071 |
|
| BLAKE2b-256 | 65ade84a68d77e39bee20c44909a8a0e3d9c30616f6cd1e2825f0c0372f3ca97 |
File details
Details for the file terminado-0.18.0-py3-none-any.whl.
File metadata
- Download URL: terminado-0.18.0-py3-none-any.whl
- Upload date:
- Size: 14.2 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 87b0d96642d0fe5f5abd7783857b9cab167f221a39ff98e3b9619a788a3c0f2e |
|
| MD5 | d43ef7b0b83113f73899e2333008e1cd |
|
| BLAKE2b-256 | 69dfdeebc9fb14a49062a3330f673e80b100e665b54d998163b3f62620b6240c |
