Skip to content

Commit 9a03817

Browse files
deathaxesuperbobry
authored andcommitted
Fix README file-mode
1 parent 4af7d54 commit 9a03817

File tree

1 file changed

+0
-0
lines changed

1 file changed

+0
-0
lines changed

README.rst

Lines changed: 0 additions & 57 deletions
This file was deleted.

README.rst

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
::
2+
3+
_
4+
| |
5+
_ __ _ _ | |_ ___
6+
| '_ \ | | | || __|/ _ \
7+
| |_) || |_| || |_| __/
8+
| .__/ \__, | \__|\___|
9+
| | __/ |
10+
|_| |___/ 0.8.3.dev
11+
12+
13+
What is ``pyte``?
14+
-----------------
15+
16+
It's an in memory VTXXX-compatible terminal emulator.
17+
*XXX* stands for a series of video terminals, developed by
18+
`DEC <http://en.wikipedia.org/wiki/Digital_Equipment_Corporation>`_ between
19+
1970 and 1995. The first, and probably the most famous one, was VT100
20+
terminal, which is now a de-facto standard for all virtual terminal
21+
emulators. ``pyte`` follows the suit.
22+
23+
So, why would one need a terminal emulator library?
24+
25+
* To screen scrape terminal apps, for example ``htop`` or ``aptitude``.
26+
* To write cross platform terminal emulators; either with a graphical
27+
(`xterm <http://invisible-island.net/xterm/>`_,
28+
`rxvt <http://rxvt.net/>`_) or a web interface, like
29+
`AjaxTerm <http://antony.lesuisse.org/software/ajaxterm/>`_.
30+
* To have fun, hacking on the ancient, poorly documented technologies.
31+
32+
**Note**: ``pyte`` started as a fork of `vt102 <http://github.com/samfoo/vt102>`_,
33+
which is an incomplete pure Python implementation of VT100 terminal.
34+
35+
36+
Installation
37+
------------
38+
39+
If you have `pip <https://pip.pypa.io/en/stable>`_ you can do the usual::
40+
41+
pip install pyte
42+
43+
Otherwise, download the source from `GitHub <https://github.com/selectel/pyte>`_
44+
and run::
45+
46+
python setup.py install
47+
48+
Similar projects
49+
----------------
50+
51+
``pyte`` is not alone in the weird world of terminal emulator libraries,
52+
here's a few other options worth checking out:
53+
`Termemulator <http://sourceforge.net/projects/termemulator/>`_,
54+
`pyqonsole <http://hg.logilab.org/pyqonsole/>`_,
55+
`webtty <http://code.google.com/p/webtty/>`_,
56+
`AjaxTerm <http://antony.lesuisse.org/software/ajaxterm/>`_ and of course
57+
`vt102 <http://github.com/samfoo/vt102>`_.

0 commit comments

Comments
 (0)