A server-side entry in TopGit's GitHub warehouse: peterbrittain/asciimatics, 4.3k stars, Backend, Python. A cross platform package to do curses-like operations, plus higher level APIs and widgets to create text UIs and ASCII art animations
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
.. |version| image:: https://img.shields.io/pypi/v/asciimatics.svg
:target: https://pypi.python.org/pypi/asciimatics
:alt: Latest stable version
.. |chat| image:: https://badges.gitter.im/asciimatics/Lobby.svg
:alt: Join the chat at https://gitter.im/asciimatics/Lobby
:target: https://gitter.im/asciimatics/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
ASCIIMATICS
Asciimatics is a package to help people create full-screen text UIs (from interactive forms to
ASCII animations) on any platform. It is licensed under the Apache Software Foundation License 2.0.
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 the low-level console function you could ask for,
including:
Coloured/styled text - including 256 colour terminals and unicode characters (even CJK languages)
Cursor positioning
Keyboard input (without blocking or echoing) including unicode support
Mouse input (terminal permitting)
Detecting and handling when the console resizes
Screen scraping
In addition, it provides some simple, high-level APIs to provide more complex features including:
Anti-aliased ASCII line-drawing
Image to ASCII conversion - including JPEG and GIF formats
Many animation effects - e.g. sprites, particle systems, banners, etc.
Various widgets for text UIs - e.g. buttons, text boxes, radio buttons, etc.
Currently this package has been proven to work on CentOS 6 & 7, Raspbian (i.e. Debian wheezy),
Ubuntu 14.04, Windows 7, 8 & 10, OSX 10.11 and Android Marshmallow (courtesy of https://termux.com),
though it should also work for any other platform that provides a working curses implementation.
It should be implementation agnostic and has been successfully tested on CPython and PyPy2.
(Please let me know if you successfully verified it on other platforms so that I can update this
list).
Installation
Asciimatics supports Python version 3. For the precise list of tested versions,
refer to pypi <https://pypi.python.org/pypi/asciimatics>_. The last version of asciimatics
to support Python 2 is v1.14.
To install asciimatics, simply install with pip as follows:
.. code-block:: bash
$ pip install asciimatics
This should install all your dependencies for you. If you don't use pip or it fails to install
them, you can install the dependencies directly using the packages listed in requirements.txt <https://github.com/peterbrittain/asciimatics/blob/master/requirements.txt>_.
Additionally, Windows users (who aren't using pip) will need to install pywin32.
How to use it?
To use the low-level API, simply create a Screen and use it to print coloured text at any location,
or get mouse/keyboard input. For example, here is a variant on the classic "hello world":
.. code-block:: python
from random import randint
from asciimatics.screen import Screen
def demo(screen):
while True:
screen.print_at('Hello world!',
randint(0, screen.width), randint(0, screen.height),
colour=randint(0, screen.colours - 1),
bg=randint(0, screen.colours - 1))
ev = screen.get_key()
if ev in (ord('Q'), ord('q')):
return
screen.refresh()
Screen.wrapper(demo)
That same code works on Windows, OSX and Linux and paves the way for all the higher level features.
These still need the Screen, but now you also create a Scene using some Effects and then get the
Screen to play it. For example, this code:
.. 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'),
int(screen.height / 2 - 8)),
Cycle(
screen,
FigletText("ROCKS!", font='big'),
int(screen.height / 2 + 3)),
Stars(screen, 200)
]
screen.play([Scene(effects, 500)])
Screen.wrapper(demo)
Or maybe you're looking to create a TUI? In which case this
simple code <https://github.com/peterbrittain/asciimatics/blob/master/samples/contact_list.py>__
will give you this:
.. image:: https://asciinema.org/a/45946.png
:alt: contact list sample
:target: https://asciinema.org/a/45946?autoplay=1
Documentation
Full documentation of all the above (and more!) 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/v1.15/samples.
To view them, simply download these files and then simply run them directly with python.
Alternatively, you can browse recordings of many of the samples in the gallery at
https://github.com/peterbrittain/asciimatics/wiki.
Bugs and enhancements
If you have a problem, please check out the troubleshooting guide at
http://asciimatics.readthedocs.io/en/latest/troubleshooting.html. If this doesn't solve your
problem, you can report bugs (or submit enhancement requests) at
https://github.com/peterbrittain/asciimatics/issues.
Alternatively, if you just have some questions, feel free to drop in at
https://gitter.im/asciimatics/Lobby.
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/contributing.html
How active is development on peterbrittain/asciimatics?
The most recent commit recorded on peterbrittain/asciimatics was 4 months ago, based on the GitHub push timestamp. The repository has 270 forks — one of the better signals of community interest.
How does peterbrittain/asciimatics compare to other Backend projects?
peterbrittain/asciimatics is tracked by TopGit in the Backend category, with 4.3k GitHub stars and written in Python. Browse the Backend topic page on TopGit to compare it against similar projects by stars and activity.
How many stars does peterbrittain/asciimatics have?
peterbrittain/asciimatics has 4.3k GitHub stars — refresh the page for the live number, or check github.com/peterbrittain/asciimatics. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What is peterbrittain/asciimatics?
peterbrittain/asciimatics (peterbrittain/asciimatics) is a Python project on GitHub. From the project's own README: A cross platform package to do curses-like operations, plus higher level APIs and widgets to create text UIs and ASCII art animations
What language is peterbrittain/asciimatics written in?
peterbrittain/asciimatics is written primarily in Python. GitHub's language field is based on the largest share of bytes in the default branch.
What topics is peterbrittain/asciimatics associated with?
GitHub's repository topics for peterbrittain/asciimatics: "ascii-art", "console", "cross-platform", "curses", "python", "terminal", "tui". TopGit's editorial category is Backend.
Why is peterbrittain/asciimatics categorized under Backend?
TopGit places peterbrittain/asciimatics in the Backend category based on its GitHub topics and description (tagged: "ascii-art", "console", "cross-platform"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Still deciding about asciimatics?
One click hands the question to an AI along with this page — see what it says about asciimatics.