133 lines
5.8 KiB
Plaintext
133 lines
5.8 KiB
Plaintext
|
Metadata-Version: 2.1
|
||
|
|
Name: terminado
|
||
|
|
Version: 0.17.1
|
||
|
|
Summary: Tornado websocket backend for the Xterm.js Javascript terminal emulator library.
|
||
|
|
Project-URL: Homepage, https://github.com/jupyter/terminado
|
||
|
|
Author-email: Jupyter Development Team <jupyter@googlegroups.com>
|
||
|
|
License: # terminado: A python websocket server backend for xterm.js
|
||
|
|
#
|
||
|
|
# BSD License
|
||
|
|
#
|
||
|
|
# Copyright (c) 2014-, Jupyter development team
|
||
|
|
# Copyright (c) 2014, Ramalingam Saravanan <sarava@sarava.net>
|
||
|
|
# All rights reserved.
|
||
|
|
#
|
||
|
|
# Redistribution and use in source and binary forms, with or without
|
||
|
|
# modification, are permitted provided that the following conditions are met:
|
||
|
|
#
|
||
|
|
# 1. Redistributions of source code must retain the above copyright notice, this
|
||
|
|
# list of conditions and the following disclaimer.
|
||
|
|
# 2. Redistributions in binary form must reproduce the above copyright notice,
|
||
|
|
# this list of conditions and the following disclaimer in the documentation
|
||
|
|
# and/or other materials provided with the distribution.
|
||
|
|
#
|
||
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
||
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
||
|
|
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
||
|
|
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
|
||
|
|
# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
|
||
|
|
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
|
||
|
|
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
|
||
|
|
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
|
|
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
|
||
|
|
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
License-File: LICENSE
|
||
|
|
Classifier: Environment :: Web Environment
|
||
|
|
Classifier: License :: OSI Approved :: BSD License
|
||
|
|
Classifier: Programming Language :: Python :: 3
|
||
|
|
Classifier: Topic :: Terminals :: Terminal Emulators/X Terminals
|
||
|
|
Requires-Python: >=3.7
|
||
|
|
Requires-Dist: ptyprocess; os_name != 'nt'
|
||
|
|
Requires-Dist: pywinpty>=1.1.0; os_name == 'nt'
|
||
|
|
Requires-Dist: tornado>=6.1.0
|
||
|
|
Provides-Extra: docs
|
||
|
|
Requires-Dist: myst-parser; extra == 'docs'
|
||
|
|
Requires-Dist: pydata-sphinx-theme; extra == 'docs'
|
||
|
|
Requires-Dist: sphinx; extra == 'docs'
|
||
|
|
Provides-Extra: test
|
||
|
|
Requires-Dist: pre-commit; extra == 'test'
|
||
|
|
Requires-Dist: pytest-timeout; extra == 'test'
|
||
|
|
Requires-Dist: pytest>=7.0; extra == 'test'
|
||
|
|
Description-Content-Type: text/markdown
|
||
|
|
|
||
|
|
# Terminado
|
||
|
|
|
||
|
|
[](https://github.com/jupyter/terminado/actions/workflows/test.yml/badge.svg?query=branch%3Amain++)
|
||
|
|
[](https://codecov.io/gh/jupyter/terminado)
|
||
|
|
[](http://terminado.readthedocs.io/en/latest/?badge=latest)
|
||
|
|
|
||
|
|
This is a [Tornado](http://tornadoweb.org/) websocket backend for the
|
||
|
|
[Xterm.js](https://xtermjs.org/) Javascript terminal emulator library.
|
||
|
|
|
||
|
|
It evolved out of [pyxterm](https://github.com/mitotic/pyxterm), which
|
||
|
|
was part of [GraphTerm](https://github.com/mitotic/graphterm) (as
|
||
|
|
lineterm.py), v0.57.0 (2014-07-18), and ultimately derived from the
|
||
|
|
public-domain [Ajaxterm](http://antony.lesuisse.org/software/ajaxterm/)
|
||
|
|
code, v0.11 (2008-11-13) (also on Github as part of
|
||
|
|
[QWeb](https://github.com/antonylesuisse/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](http://www.tornadoweb.org/en/stable/guide/templates.html#ui-modules).
|
||
|
|
|
||
|
|
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:
|
||
|
|
|
||
|
|
```python
|
||
|
|
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](https://github.com/takluyver/terminado/tree/master/demos) for
|
||
|
|
more examples. This is a simplified version of the `single.py` demo.
|
||
|
|
|
||
|
|
Run the unit tests with:
|
||
|
|
|
||
|
|
> $ pytest
|