Metadata-Version: 1.1
Name: asciimatics
Version: 1.3.0
Summary: A unified package to do curses-like operations across all platforms (including Windows) and create ASCII art animations
Home-page: https://github.com/peterbrittain/asciimatics.git
Author: Peter Brittain
Author-email: peter.brittain.os@gmail.com
License: Apache 2.0
Description: ASCIIMATICS
        ===========
        
        Asciimatics is a package to help people create simple ASCII animations on any
        platform.  It is licensed under the Apache Software Foundation License 2.0.
        
        It originated from some work that I did on PiConga to create a retro text
        credits roll for the project.  This worked so well, I re-used it for another
        project.  At that point I felt it might be fun to share with others.
        
        
        Why?
        ----
        
        Why not?  It brings a little joy to anyone who was programming in the 80s...
        Oh and it provides a single cross-platform Python class to do all basic console
        function, including:
        
        * Coloured/styled text - including 256 colour terminals
        * Cursor positioning
        * Keyboard input (without blocking or echoing)
        * Detecting and handling when the console resizes
        
        Currently this API has been proven to work on CentOS 6 & 7 and Windows 7 & 8,
        though it should also work for any platform that provides a working curses
        implementation.  
        
        (Please let me know if you successfully verified it on other platforms so
        that I can update this list).
        
        Installation
        ------------
        
        To install asciimatics, simply:
        
        .. code-block:: bash
        
            $ pip install asciimatics
        
        
        How to use it?
        --------------
        
        Create a Screen, put together a Scene using some
        Effects and then get the Screen to play it.
        
        .. code-block:: python
        
            from asciimatics.effects import Cycle, Stars
            from asciimatics.renderers import FigletText
            from asciimatics.scene import Scene
            from asciimatics.screen import Screen
            
            def demo(screen):
                effects = [
                    Cycle(
                        screen,
                        FigletText("ASCIIMATICS", font='big'),
                        screen.height / 2 - 8),
                    Cycle(
                        screen,
                        FigletText("ROCKS!", font='big'),
                        screen.height / 2 + 3),
                    Stars(screen, 200)
                ]
                screen.play([Scene(effects, 500)])
            
            Screen.wrapper(demo)
        
        And you should see something like this:
        
        .. image:: https://asciinema.org/a/18756.png
           :alt: asciicast
           :target: https://asciinema.org/a/18756?autoplay=1
        
        Documentation
        -------------
        
        Documentation is available at http://asciimatics.readthedocs.org/
        
        More Examples
        -------------
        
        More examples of what you can do are available in the project samples directory, hosted on GitHub.  See https://github.com/peterbrittain/asciimatics/tree/master/samples.
        
        Alternatively, you can browse the gallery at https://github.com/peterbrittain/asciimatics/wiki.
        
        Bugs and enhancements
        ---------------------
        
        You can report bugs and submit enhancement requests at https://github.com/peterbrittain/asciimatics/issues
        
        Contributing to the project
        ---------------------------
        
        If you'd like to take part in this project (and see your name in the credits!), check out the guidance at
        http://asciimatics.readthedocs.org/en/latest/intro.html#contributing-to-this-project.
        
Keywords: ascii art demo credits title sequence animation curses windows
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Text Processing :: General
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
