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 a Terminal Tornado 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 files for terminado 0.18.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for terminado 0.18.1
File	Size	Uploaded
terminado-0.18.1.tar.gz	32.7 kB	Mar 12, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for terminado 0.18.1
File	Interpreter	ABI	Platform	Reset
terminado-0.18.1-py3-none-any.whl 14.2 kB Mar 12, 2024	Python 3	none	any	Details

Total release size: 46.9 kB

Release files / terminado-0.18.1.tar.gz

Download URL	terminado-0.18.1.tar.gz
Size	32.7 kB
Tags	Source
SHA-256 checksum How to use checksums	`de09f2c4b85de4765f7714688fff57d3e75bad1f909b589fde880460c753fd2e`
BLAKE2b-256 checksum How to use checksums	`8a11965c6fd8e5cc254f1fe142d547387da17a8ebfd75a3455f637c663fb38a0`
Upload date	Mar 12, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.0.0 CPython/3.11.8`

Release files / terminado-0.18.1-py3-none-any.whl

Download URL	terminado-0.18.1-py3-none-any.whl
Size	14.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`a4468e1b37bb318f8a86514f65814e1afc977cf29b3992a4500d9dd305dcceb0`
BLAKE2b-256 checksum How to use checksums	`6a9e2064975477fdc887e47ad42157e214526dcad8f317a948dee17e1659a62f`
Upload date	Mar 12, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/5.0.0 CPython/3.11.8`