Skip to main content

Simple terminal manipulator

Project description

TermIO

Simple library that makes it easier to manipulate the terminal using escape sequences.

It does not work in all terminal and terminal-emulators. But i have generally had good with bash.

import TermIO

func TermIO.TermSize.Rows(Update=True)

Returns rows in terminal as an int.

Update : BOOL, should you check the terminal size again, or just [True]
                assume that it hasn't changed since last check.

func TermIO.TermSize.Columns(Update=True)

Returns Columns in terminal as an int.

Update : BOOL, should you check the terminal size again, or just [True]
                assume that it hasn't changed since last check.

func TermIO.Cursor.SetPos(col, row, flush=True)

Set cursor to a spesific column and row in the terminal.

col   : The column number to put the cursor.
row   : The row number to put the cursor.
flush : Wether or not to flush the codes printed (Default is true).

func TermIO.Cursor.Left(n, flush=True)

Move the cursor n characters to the left.

n     : number
flush : Wether or not to flush the codes printed (Default is true).

func TermIO.Cursor.Right(n, flush=True)

Move the cursor n characters to the right.

n     : number
flush : Wether or not to flush the codes printed (Default is true).

func TermIO.Cursor.Up(n, flush=True)

Move the cursor n characters up.

n     : number
flush : Wether or not to flush the codes printed (Default is true).

func TermIO.Cursor.Down(n, flush=True)

Move the cursor n characters to the down.

n     : number
flush : Wether or not to flush the codes printed (Default is true).

func TermIO.Screen.Clear(flush=True)

Clear the screen.

flush : Wether or not to flush the codes printed (Default is true).

func TermIO.Screen.Flush()

Flushes printed content to screen.

func TermIO.Screen.Decorate(fg=None, bg=None, dec=None, flush=True)

Clear the screen

fg    : Number between 0 and 255. No logical color math... [None]
bg    : Number between 0 and 255. No logical color math... [None]
dec   : Either a string or a list of strings. [None]
            The three possible decorations is
            reversed, underline, bold
            eg:
                TermIO.Screen.Decorate(dec="reversed")
            or
                TermIO.Screen.Decorate(dec=["bold", "reversed"])
flush : Wether or not to flush the codes printed. [True]

If you want to print ESC[0M, to remove all decorations. Just call this function with fg=bg=dec=None.

func TermIO.Screen.Write(outStr, flush=True)

Writes a string to stdout.

outStr : string to be printed
flush  : Wether or not to flush the codes printed (Default is true).

Project details


Download files

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

Files for TermIO, version 0.1.6
Filename, size File type Python version Upload date Hashes
Filename, size TermIO-0.1.6-py3-none-any.whl (16.9 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size TermIO-0.1.6.tar.gz (2.9 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page