Skip to main content

Curses-like terminal wrapper, with colored strings!

Project description

Build Status Documentation Status Curtsies Logo

Curtsies is a Python 2.7 & 3.4+ compatible library for interacting with the terminal. This is what using (nearly every feature of) curtsies looks like:

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.

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
  • #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.3.4.tar.gz (52.7 kB view details)

Uploaded Source

Built Distribution

curtsies-0.3.4-py2.py3-none-any.whl (35.0 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: curtsies-0.3.4.tar.gz
  • Upload date:
  • Size: 52.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.2

File hashes

Hashes for curtsies-0.3.4.tar.gz
Algorithm Hash digest
SHA256 4ca543998d8bbba7185db099f8b7bb30baeb47426f7ac1a271e4d9ca8bbb2b05
MD5 198593de25ec54f8285bb3d94239c769
BLAKE2b-256 711ce02ad3efff0bd806d774aa8e9f26f0ac4398d557b7929038e7defde161b2

See more details on using hashes here.

File details

Details for the file curtsies-0.3.4-py2.py3-none-any.whl.

File metadata

  • Download URL: curtsies-0.3.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.8.2

File hashes

Hashes for curtsies-0.3.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 068db8e5d8a2f23b765d648a66dfa9445cf2412177126ae946a7357ade992640
MD5 10175ee1e9bab33d8af38e967358949c
BLAKE2b-256 2462cf851b0815affc43992afb77cc9822e9df89eac272fbcb855dbd34dfa098

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