Termynal

0.14.0 verified Fri May 01 auth: no python

A lightweight and modern animated terminal window for Python, used to create animated terminal recordings for documentation and demos. Current version is 0.14.0, released monthly.

pip install termynal

Common errors

error AttributeError: module 'termynal' has no attribute 'Termynal' ↓

cause Wrong import: import termynal then termynal.Termynal fails because the top-level module does not re-export the class.

fix

Use: from termynal import Termynal

error NameError: name 'Termynal' is not defined ↓

cause Import statement missing or wrong.

fix

Add: from termynal import Termynal

error TypeError: __init__() got an unexpected keyword argument 'title' ↓

cause Version mismatch: older version used 'title' parameter; v0.14.0 renamed to 'header' or expects different arguments.

fix

Check docs for current constructor signature; remove 'title' or use 'header'.

Warnings

breaking Version 0.14.0 removed the old synchronous 'run' method and replaced it with 'show' which is blocking. Code using t.run() will raise AttributeError. ↓

fix Replace t.run() with t.show().

gotcha Termynal.show() blocks the main thread until the animation completes. This can freeze UI applications or CLI tools. ↓

fix Call show() only at end of script or in a separate thread.

deprecated The 'termynal' module-level function termynal() used for quick generation is deprecated since v0.12, use Termynal class directly. ↓

fix Use from termynal import Termynal and instantiate the class.

Imports

Termynal
wrong
```
import termynal
```
correct
```
from termynal import Termynal
```
Importing the module itself does not expose the main class; you must import Termynal directly.
Line
```
from termynal import Line
```

Quickstart

Create a basic animated terminal session with a few lines.

from termynal import Termynal, Line

# Create a simple terminal animation
t = Termynal()
t.add(Line("$ pip install termynal"))
t.add(Line("Collecting termynal..."))
t.add(Line("Installing collected packages: termynal"))
t.show()