Metadata-Version: 1.0
Name: term
Version: 2.0
Summary: An enhanced version of the tty module
Home-page: http://pypi.python.org/pypi/term
Author: Stefan H. Holek
Author-email: stefan@epy.co.at
License: GPL or PSF
Description: =====
        term
        =====
        --------------------------------------
        An enhanced version of the tty module
        --------------------------------------
        
        Overview
        ========
        
        The **term** package is an enhanced version of the standard library's
        tty_ module.
        It provides context managers for temporarily switching the terminal
        to *raw* or *cbreak* mode and allows to retrieve the cursor position
        without having to resort to curses.
        
        .. _tty: http://docs.python.org/library/tty.html
        
        Package Contents
        ----------------
        
        setraw(fd, when=TCSAFLUSH, min=1, time=0)
            Put the terminal in raw mode.
        
        setcbreak(fd, when=TCSAFLUSH, min=1, time=0)
            Put the terminal in cbreak mode.
        
        rawmode(fd, when=TCSAFLUSH, min=1, time=0)
            Context manager to put the terminal in raw mode.
        
        cbreakmode(fd, when=TCSAFLUSH, min=1, time=0)
            Context manager to put the terminal in cbreak mode.
        
        opentty(bufsize=1)
            Context manager returning an rw stream connected to /dev/tty.
            The stream is None if the device could not be opened.
        
        getyx()
            Return the cursor position as 1-based (line, col) tuple.
            line and col are 0 if the terminal does not support DSR 6.
        
        Examples
        --------
        ::
        
            from term import getyx
        
            print 'The cursor is in line %d column %d' % getyx()
        
        You may also want to look at the `source code`_ of getyx.
        
        .. _`source code`: https://github.com/stefanholek/term/blob/master/term/__init__.py#L140
        
        Caveat
        ------
        
        The terminal must be in canonical mode before any of the functions and
        context managers can be used. They are not meant for switching between, say,
        raw and cbreak modes. Nesting context managers of the same type is ok though.
        
        
        Changelog
        =========
        
        2.0 - 2012-04-27
        ----------------
        
        - Open /dev/tty in binary mode under Python 3.
          [stefan]
        
        - Disable buffering if the device is not seekable.
          [stefan]
        
        - Remove getmaxyx since it cannot be implemented reliably.
          [stefan]
        
        - Support Python 2.5.
          [stefan]
        
        - Change license to GPL or PSF to avoid relicensing of PSF code.
          [stefan]
        
        
        1.0 - 2012-04-11
        ----------------
        
        - Initial release.
          [stefan]
        
Keywords: terminal tty raw cbreak opentty getyx cursor position
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License (GPL)
Classifier: License :: OSI Approved :: Python Software Foundation License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
