Metadata-Version: 1.1
Name: curtsies
Version: 0.2.11
Summary: Curses-like terminal wrapper, with colored strings!
Home-page: https://github.com/thomasballinger/curtsies
Author: Thomas Ballinger
Author-email: thomasballinger@gmail.com
License: MIT
Description: |Build Status| |Documentation Status| |Curtsies Logo|
        
        Curtsies is a library for interacting with the terminal. This is what
        using (nearly every feature of) curtsies looks like:
        
        .. code:: python
        
            from __future__ import unicode_literals # convenient for Python 2
            import random
        
            from curtsies import FullscreenWindow, Input, FSArray
            from curtsies.fmtfuncs import red, bold, green, on_blue, yellow
        
            print(yellow('this prints normally, not to the alternate screen'))
            with FullscreenWindow() as window:
                with Input() as input_generator:
                    msg = red(on_blue(bold('Press escape to exit')))
                    a = FSArray(window.height, window.width)
                    a[0:1, 0:msg.width] = [msg]
                    for c in input_generator:
                        if c == '<ESC>':
                            break
                        elif c == '<SPACE>':
                            a = FSArray(window.height, window.width)
                        else:
                            s = repr(c).decode()
                            row = random.choice(range(window.height))
                            column = random.choice(range(window.width-len(s)))
                            color = random.choice([red, green, on_blue, yellow])
                            a[row, column:column+len(s)] = [color(s)]
                        window.render_to_terminal(a)
        
        Paste it in a ``something.py`` file and try it out!
        
        Installation: ``pip install curtsies``
        
        `Documentation <http://curtsies.readthedocs.org/en/latest/>`__
        
        Primer
        ------
        
        `FmtStr <http://curtsies.readthedocs.org/en/latest/FmtStr.html>`__
        objects are strings formatted with colors and styles displayable in a
        terminal with `ANSI escape
        sequences <http://en.wikipedia.org/wiki/ANSI_escape_code%3E%60_>`__.
        
        (the import statement shown below is outdated)
        
        .. figure:: http://i.imgur.com/7lFaxsz.png
           :alt: 
        
        `FSArray <http://curtsies.readthedocs.org/en/latest/FSArray.html>`__
        objects contain multiple such strings with each formatted string on its
        own row, and FSArray objects can be superimposed on each other to build
        complex grids of colored and styled characters through composition.
        
        (the import statement shown below is outdated)
        
        .. figure:: http://i.imgur.com/rvTRPv1.png
           :alt: 
        
        Such grids of characters can be rendered to the terminal in alternate
        screen mode (no history, like ``Vim``, ``top`` etc.) by
        `FullscreenWindow <http://curtsies.readthedocs.org/en/latest/window.html#curtsies.window.FullscreenWindow>`__
        objects or normal history-preserving screen by
        `CursorAwareWindow <http://curtsies.readthedocs.org/en/latest/window.html#curtsies.window.CursorAwareWindow>`__
        objects. User keyboard input events like pressing the up arrow key are
        detected by an
        `Input <http://curtsies.readthedocs.org/en/latest/input.html>`__ object.
        
        Examples
        --------
        
        -  `Tic-Tac-Toe </examples/tictactoeexample.py>`__
        
        .. figure:: http://i.imgur.com/AucB55B.png
           :alt: 
        
        -  `Avoid the X's game </examples/gameexample.py>`__
        
        .. figure:: http://i.imgur.com/nv1RQd3.png
           :alt: 
        
        -  `Bpython-curtsies uses
           curtsies <http://ballingt.com/2013/12/21/bpython-curtsies.html>`__
        
        |image3|
        
        -  `More examples </examples>`__
        
        About
        -----
        
        -  `Curtsies
           Documentation <http://curtsies.readthedocs.org/en/latest/>`__
        -  Curtsies was written to for
           `bpython-curtsies <http://ballingt.com/2013/12/21/bpython-curtsies.html>`__
        -  ``#bpython`` on irc is a good place to talk about Curtsies, but feel
           free to open an issue if you're having a problem!
        -  Thanks to the many contributors!
        -  If all you need are colored strings, consider one of these `other
           libraries <http://curtsies.readthedocs.io/en/latest/FmtStr.html#fmtstr-rationale>`__!
        
        .. |Build Status| image:: https://travis-ci.org/thomasballinger/curtsies.svg?branch=master
           :target: https://travis-ci.org/thomasballinger/curtsies
        .. |Documentation Status| image:: https://readthedocs.org/projects/curtsies/badge/?version=latest
           :target: https://readthedocs.org/projects/curtsies/?badge=latest
        .. |Curtsies Logo| image:: http://ballingt.com/assets/curtsiestitle.png
        .. |image3| image:: http://i.imgur.com/r7rZiBS.png
           :target: http://www.youtube.com/watch?v=lwbpC4IJlyA
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
