Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/etienne-napoleone/scrmbl
🛰 Scrambled text reveal library and cli
https://github.com/etienne-napoleone/scrmbl
cli command-line fun glitch print python python-library
Last synced: 13 days ago
JSON representation
🛰 Scrambled text reveal library and cli
- Host: GitHub
- URL: https://github.com/etienne-napoleone/scrmbl
- Owner: etienne-napoleone
- License: mit
- Created: 2018-10-04T17:21:35.000Z (about 6 years ago)
- Default Branch: develop
- Last Pushed: 2021-01-22T19:26:30.000Z (almost 4 years ago)
- Last Synced: 2024-09-30T23:42:54.589Z (about 2 months ago)
- Topics: cli, command-line, fun, glitch, print, python, python-library
- Language: Python
- Homepage:
- Size: 1.81 MB
- Stars: 95
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
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.
```bash
pip install scrmbl
```
Using Poetry:
```bash
poetry add scrmbl
```
Using Pipenv:
```bash
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.
```bash
ls -lrtha | scrmbl
```
## Library
```python
>>> 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:
- [@podstava](https://github.com/podstava)
- [@0jdxt](https://github.com/0jdxt)