scr

scrmbl

🛰 Scrambled text reveal library and cli

Showing:

Popularity

Downloads/wk

0

GitHub Stars

93

Maintenance

Last Commit

9mos ago

Contributors

4

Package

Dependencies

1

License

MIT

Categories

Readme

scrmbl

Library and CLI for "scrambled" printing in terminal.

Have you ever wanted to print your text like some corny action movies?

note: the % are coming from my tty recorder

Requirements

  • Tested on Python >= 3.5

Install

CLI

pip3 install --user scrmbl

Library

Using pip in a virtualenv.

pip install scrmbl

Using Poetry:

poetry add scrmbl

Using Pipenv:

pipenv install scrmbl

Usage

Refer to the gif to see the effect

CLI

Usage: scrmbl [OPTIONS] [MESSAGE]

  Scrmbl print the given message.

Options:
  -s, --speed FLOAT         Time in seconds between prints. Default: 0.05
  -i, --iterations INTEGER  Number of iterations per character. Default: 2
  -c, --charset FILE        Set of chars to scramble.
  --version                 Show the version and exit.
  --help                    Show this message and exit.

Can also read from stdin.

ls -lrtha | scrmbl

Library

>>> import scrmbl

>>> scrmbl.echo('09:30pm, Washington, NSA HEADQUARTERS')
'09:30pm, Washington, NSA HEADQUARTERS'

# handle multiline
>>> scrmbl.echo('09:30pm, Washington\nNSA HEADQUARTERS')
'02:56am, New-York'
'FBI HEADQUARTERS'

# custom settings:
# charset = String of characters to scramble with
# speed = Time in seconds between prints
# iterations = number of iterations before printing the final character
>>> scrmbl.echo('NSA OFFICE', charset='ABCDefg/-', speed=0.2, iterations=6)
'CIA OFFICE'

Thanks

Special thanks for contributing:

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Alternatives

No alternatives found

Tutorials

No tutorials found
Add a tutorial