Braillert

Generate braille arts using various palette types.

_{Built with ❤︎ by idmp152}

_{Readme inspiration: freyr-js}

Demo

Description

Braillert is a text art generator using braille symbols. It supports multiple color palettes including 2-color grayscale, extended grayscale, high and low 8-color palette, 16 and 256 color palettes. Can be used either as a CLI program or a library.

Installation

pip install braillert

Usage

braillert [-h] -fp FILE_PATH [-m {2,8_lo,8_hi,16,256,gs_ext}] [-w WIDTH] [-o OUT] [-t THRESHOLD] [-dl] [-gf] [-r]

--file-path or -fp - a required argument that represents the path where the convertible image is located e.g.

-fp=art.png

--mode or -m - a required argument that represents the mode in which the provided image should be converted e.g.

--mode=2

or

-m=8_lo

Available modes:

• 2 (grayscale)
• 8_lo (lower 8 colors)
• 8_hi (higher 8 colors)
• 16 (16 colors palette)
• 256 (full colors palette)
• gs_ext (24 color grayscale extended palette)

--width or -w - an optional argument that represents the width in which the provided image should be resized e.g.

--width=150

--out or -o - an optional argument that represents the path in which the art should be saved e.g

--out=./art.ansi

--threshold or -t - an optional argument that represents the threshold value that will be used during the art generation e.g.

--threshold=130

Documentation

Still WIP but a small documentation on each file is available using pydoc. (every public class and function also has annotations and docstrings)