Metadata-Version: 2.1
Name: simpleANSI
Version: 1.0.2
Summary: A simple wrapper for ANSI escape codes
Home-page: https://github.com/AwesomeCronk/simpleANSI
Author: AwesomeCronk
Author-email: awesomecronk@gmail.com
License: MIT
Download-URL: https://pypi.org/project/simpleANSI
Keywords: ANSI
Platform: UNKNOWN
Description-Content-Type: text/markdown

## simpleANSI
This is a simple wrapper library for ANSI escape codes.

GitHub: https://github.com/AwesomeCronk/simpleANSI

PyPI: https://pypi.org/project/simpleANSI/0.1.0/

# Installation
`pip install simpleANSI`

# Functionality
This is the directory of the package. Functions are denoted as `function(args)`. Constants are denoted as `constant = value`. Anything with a listing under it is a module. All functions under submodules return a string containing the proper escape codes. This string must be printed with `print(<function>(*args), end = '')` to achieve the desired effect. The only function that does not behave like this is `simpleANSI.conhostEnableANSI()`. This function is required on windows to enable ANSI escapes in a conhost terminal (the default terminal).
```
simpleANSI
|-conhostEnableANSI()
|-clear
| |-screen()
| |-screenToEnd()
| |-screenToBeg()
| |-entireScree()
| |-line()
| |-lineToEnd()
| |-lineToBeg()
| `-entireLine()
|-cursor
| |-home()
| |-moveTo(line, column)
| |-moveUpBy(lines)
| |-moveDownBy(lines)
| |-moveRightBy(columns)
| |-moveLeftBy(columns)
| |-moveBegNext(lines)
| |-moveBegPrev(lines)
| |-moveToCol(column)
| |-savePos()
| `-restorePos()
`-graphics
  |-normal = 0
  |-bold = 1
  |-underline = 4
  |-blink = 5
  |-invert = 7
  |-invisible = 8
  |-fgBlack = 30
  |-fgRed = 31
  |-fgGreen = 32
  |-fgYellow = 33
  |-fgBlue = 34
  |-fgMagenta = 35
  |-fgCyan = 36
  |-fgWhite = 37
  |-fgColor = 38
  |-bgBlack = 40
  |-bgRed = 41
  |-bgGreen = 42
  |-bgYellow = 43
  |-bgBlue = 44
  |-bgMagenta = 45
  |-bgCyan = 46
  |-bgWhite = 47
  |-bgColor = 48
  |-mode8Bit = 5
  |-mode16Bit = 2
  `-setGraphicsMode(*args)
```

# Resources:
* https://gist.github.com/fnky/458719343aabd01cfb17a3a4f7296797# 
* https://bluesock.org/~willkg/dev/ansi.html



