<commit_before>ASCIIMATICS
===========

Asciimatics is a package to help people create simple ASCII animations using
curses.  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...


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

To install asciimatics, simply:

.. code-block:: bash

    $ pip install asciimatics


How to use it?
--------------

Create a curses window, create a Screen, put together a Scene using some
Effects and then get the Screen to play it.

.. code-block:: python

    curses.wrapper(demo)
    def demo(win):
        screen = Screen(win)
        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)])

And you should see something like this:

!["ASCII cast"](https://asciinema.org/a/18756.png "ASCIIMATICS ROCKS!")

Documentation
-------------

Documentation is available at http://asciimatics.readthedocs.org/en/latest/<commit_msg>FInally sort embedded image now that we have a .md extension!<commit_after>ASCIIMATICS
===========

Asciimatics is a package to help people create simple ASCII animations using
curses.  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...


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

To install asciimatics, simply:

.. code-block:: bash

    $ pip install asciimatics


How to use it?
--------------

Create a curses window, create a Screen, put together a Scene using some
Effects and then get the Screen to play it.

.. code-block:: python

    curses.wrapper(demo)
    def demo(win):
        screen = Screen(win)
        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)])

And you should see something like this:

[![asciicast](https://asciinema.org/a/18756.png)](https://asciinema.org/a/18756?autoplay=1)

Documentation
-------------

Documentation is available at http://asciimatics.readthedocs.org/en/latest/
{'fraction_non_alphanumeric': 0.11628686327077747, 'fraction_numerical': 0.014745308310991957, 'mean_word_length': 2.309312638580931, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5719984', 'n_tokens_mistral': 920, 'n_tokens_neox': 847, 'n_words': 330}