Swag up your shell output with escape code magic!
Project description
Swag
Color your shell output with escape code magic.
Installation
pip install swag
Usage
Usage: swag [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion [bash|zsh|fish|powershell|pwsh]
Install completion for the specified shell.
--show-completion [bash|zsh|fish|powershell|pwsh]
Show completion for the specified shell, to
copy it or customize the installation.
--help Show this message and exit.
Commands:
install
list
print
CLI Usage
Print to the cli
You can print colored from the shell as follows:
swag print --color yellow --modifier intense_bold "This text will be intense_bold and yellow :-)"
The possible modifiers are:
- underline
- background
- bold
- intense
- intense_bold
- intense_background
Installation to a folder
From the commandline do:
swag install --dest <path/to/folder> # default is ~/.colors
This will install all the escape codes to the ~/.colors or <path/to/folder> folder.
Now you can use the colors directly from the console via:
echo $(cat ~/.colors/blue) This will be blue
List all colors
Prints a list of colors (color coded).
swag list
Use from code
Print to the console
from swag import red, green, reset, INTENSE
red("This will be red")
green("Blah", modifier=INTENSE) # Prints an intense green
# Prints an intense green, to the end of the output, means if you use print after it will be green too:
green("This is green until the end", modifier=INTENSE, continuous=True)
print("This will still be green")
reset() # From now on the default cli color will be used
Use the colors in a string
from swag import colors
print(f"{colors.red}This will be red{colors.reset}")
License
This project is licensed under the GPL-3 license.
Project details
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
swag-2.0.5.tar.gz
(16.1 kB
view hashes)
Built Distribution
swag-2.0.5-py3-none-any.whl
(29.7 kB
view hashes)