Skip to main content

Terminals served to xterm.js using Tornado websockets

Project description

This is a Tornado websocket backend for the term.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.

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:

$ nosetests

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

terminado-0.7.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

terminado-0.7-py2.py3-none-any.whl (33.1 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file terminado-0.7.tar.gz.

File metadata

  • Download URL: terminado-0.7.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for terminado-0.7.tar.gz
Algorithm Hash digest
SHA256 8c73bb515ca2dca9d5958877cfe0b418a2c59b0b7eef4a79a0c3e990eab1a318
MD5 119675884d3eba2646b577fcb0de3b3a
BLAKE2b-256 6fb631371ec7e805ca2db901cc52302cd517a1bfe512b382ddbedd851dde8515

See more details on using hashes here.

File details

Details for the file terminado-0.7-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for terminado-0.7-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 57858bd06c6f20f66971aa62377e14e88995f6d6ec70ded7d1d2fcbdad570c8a
MD5 af1714d4157697b6f26691ebd31dc885
BLAKE2b-256 1ce72e0db4a19ef1ec0bc492cfde9a5c2c6a9cd09569eb1934fcc7cf17a0f2f8

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page