Usage

To use ecstasy, you mark up a standard Python string using ecstasy’s special syntax, chose some sassy styling and formatting flags, pass them on to the package-level beautify() method and, in return, get your beautified string, ready to kick ass when printed to your command-line:

import ecstasy

# <...> is a normal phrase, its style is determined by its position
# <(x)...> is a phrase with an argument, its style is the one at index 'x'
# <<...> <...>> is a phrase with nested phrases, their styles cascade
text = "<Cats> are <(0)just> <<small>, furry <elephants>>!"

# Beautify text by specifying styles via flag combinations
text = ecstasy.beautify(text,
                        ecstasy.Style.Blink   | ecstasy.Color.Red,
                        ecstasy.Style.Bold    | ecstasy.Fill.Blue,
                        ecstasy.Color.Magenta | ecstasy.Style.Underline,
                        small=ecstasy.Style.Invert | ecstasy.Color.White)

# Keyword arguments (small=...) cause all phrases matching the string of
# the key to have the style specified by the keyword argument's value.

print(text)

Running this in a script from a command-line outputs:

Installation

Now that you’re convinced, you can install ecstasy with pip:

$ pip install ecstasy

… and get crackin’.

Documentation

Full documentation and usage descriptions specifying all possible options and possibilities of how you can beautify your strings with ecstasy can be found here.

Compatibility

License

Ecstasy is released under the MIT license.

Authors

Peter Goldsborough & cat :heart: