Curses-like terminal wrapper, with colored strings!
Project description
Curtsies is a Python 3.6+ compatible library for interacting with the terminal. This is what using (nearly every feature of) curtsies looks like:
import random
import sys
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:
a = FSArray(window.height, window.width)
msg = red(on_blue(bold('Press escape to exit, space to clear.')))
a[0:1, 0:msg.width] = [msg]
window.render_to_terminal(a)
with Input() as input_generator:
for c in input_generator:
if c == '<ESC>':
break
elif c == '<SPACE>':
a = FSArray(window.height, window.width)
else:
s = repr(c)
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
Primer
FmtStr objects are strings formatted with colors and styles displayable in a terminal with ANSI escape sequences.
FSArray 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)
Such grids of characters can be rendered to the terminal in alternate screen mode
(no history, like Vim, top etc.) by FullscreenWindow objects
or normal history-preserving screen by CursorAwareWindow objects.
User keyboard input events like pressing the up arrow key are detected by an
Input object.
Examples
About
- Curtsies Documentation
- Curtsies was written to for bpython-curtsies
#bpythonon 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!
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file curtsies-0.3.10.tar.gz.
File metadata
- Download URL: curtsies-0.3.10.tar.gz
- Upload date:
- Size: 53.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 11efbb153d9cb22223dd9a44041ea0c313b8411e246e7f684aa843f6aa9c1600 |
|
| MD5 | e067b1e700b76bca45415645a85ba27c |
|
| BLAKE2b-256 | b02649fcac52193a33f024c36bc5a7f6d43fa3cecfecac307170a277b477aeba |
