Skip to main content

Curses-like terminal wrapper, with colored strings!

Project description

Build Status Documentation Status Curtsies Logo

Curtsies is a library for interacting with the terminal. This is what using (nearly every feature of) curtsies looks like:

from __future__ import unicode_literals # convenient for Python 2
import random

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:
    with Input() as input_generator:
        msg = red(on_blue(bold('Press escape to exit')))
        a = FSArray(window.height, window.width)
        a[0:1, 0:msg.width] = [msg]
        for c in input_generator:
            if c == '<ESC>':
                break
            elif c == '<SPACE>':
                a = FSArray(window.height, window.width)
            else:
                s = repr(c).decode()
                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

Documentation

Primer

FmtStr objects are strings formatted with colors and styles displayable in a terminal with ANSI escape sequences.

(the import statement shown below is outdated)

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

image3

About

  • Curtsies Documentation

  • Curtsies was written to for bpython-curtsies

  • #bpython on 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!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

curtsies-0.2.9.tar.gz (46.7 kB view details)

Uploaded Source

File details

Details for the file curtsies-0.2.9.tar.gz.

File metadata

  • Download URL: curtsies-0.2.9.tar.gz
  • Upload date:
  • Size: 46.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for curtsies-0.2.9.tar.gz
Algorithm Hash digest
SHA256 ed61334bf9fa6eaa46acad69dc95e7ea19257fa3c295c04c613cfccca941362f
MD5 9d7e3eaf67074b7563857038961c5752
BLAKE2b-256 cfc9bc36c9e0c0db8e89f959debe14dc6c52decff3ef1d50bca8bc1c242a2406

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page