Metadata-Version: 2.1
Name: termscraper
Version: 0.9.6
Summary: Simple VTXXX-compatible terminal emulator scraper.
Home-page: https://github.com/byexamples/termscraper
Author: Di Paola Martin
Author-email: use-github-issues@example.com
License: GNU LGPLv3
Keywords: scraper,pyte,vt102,vte,terminal emulator
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Terminals :: Terminal Emulators/X Terminals
Requires-Python: >=3.6
Requires-Dist: wcwidth (==0.2.5)

::

        _____                       _____
       |_   _|                     /  ___|
         | |  ___  _ __  _ __ ___  \ `--.   ___  _ __  __ _  _ __    ___  _ __
         | | / _ \| '__|| '_ ` _ \  `--. \ / __|| '__|/ _` || '_ \  / _ \| '__|
         | ||  __/| |   | | | | | |/\__/ /| (__ | |  | (_| || |_) ||  __/| |
         \_/ \___||_|   |_| |_| |_|\____/  \___||_|   \__,_|| .__/  \___||_|
                                                            | |
                                                            |_|

What is ``termscraper``?
------------------------

It’s an in memory VTXXX-compatible terminal emulator. *XXX* stands for a
series of video terminals, developed by
`DEC <http://en.wikipedia.org/wiki/Digital_Equipment_Corporation>`__
between 1970 and 1995. The first, and probably the most famous one, was
VT100 terminal, which is now a de-facto standard for all virtual
terminal emulators.

``termscraper`` follows the suit. It is a direct fork of `pyte
0.8.1 <http://github.com/selectel/pyte>`__ which in turn it is a fork of
`vt102 <http://github.com/samfoo/vt102>`__.

``termscraper`` aims to be used mostly for scraping terminal apps like
``htop`` or very long logs from ``tail`` or ``less`` in a *very
efficient* way so it may not support all the features that a full VT100
terminal would have.

Installation
------------

If you have `pip <https://pip.pypa.io/en/stable>`__ you can do the
usual:

.. code:: shell

   $ pip install termscraper

Otherwise, download the source from `GitHub
termscraper <https://github.com/byexamples/termscraper>`__ and run:

.. code:: shell

   $ python setup.py install

Similar projects
----------------

``termscraper`` is not alone in the weird world of terminal emulator
libraries, here’s a few other options worth checking out:

-  `Termemulator <http://sourceforge.net/projects/termemulator/>`__
-  `pyqonsole <http://hg.logilab.org/pyqonsole/>`__
-  `webtty <http://code.google.com/p/webtty/>`__
-  `AjaxTerm <http://antony.lesuisse.org/software/ajaxterm/>`__
-  `pyte <http://github.com/selectel/pyte>`__
-  `vt102 <http://github.com/samfoo/vt102>`__


