documentation.md

Documentation

The image_to_ascii.py file contains a single class:

ascii_image(image_dir, image_size, **kwargs)

Takes a path to an image and generates art.

To instantiate an image use:

image = ascii_image('ExamplePath/1.png', (256, 256))

Key Word Arguments	Description	Default
screen_size	the ASCII art size (in characters)	(90, 40)
reverse_charset	if you want negative images, set this flag to True	False
charset	The character set to use (see bellow)	' .-:=+*#%@'

Character Sets

    basic = ' .-:=+*#%@'
    black_and_white = ' #'
    black_grey_and_white = ' +#'
    full = '$@B%8&WM#*oahkbdpqwmZO0QLCJUYXzcvunxrjft/\|()1{}[]?-_+~<>i!lI;:,"^`. '

use:

CharacterSets.basic

To draw the image, use:

image.display()

Example:

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@++++++++++++++++++++++++++#@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@====================================+@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@==============================================+@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@=====================================================@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@===========================================================@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@===============================================================@@@@@@@@@@@@@
@@@@@@@@@@@+===================================================================@@@@@@@@@@@
@@@@@@@@@*=======================================================================@@@@@@@@@
@@@@@@@@==========================================================================*@@@@@@@
@@@@@@=:::::========================================================================@@@@@@
@@@@@=:::::::::======================================================================@@@@@
@@@@=::::::::::::::::::::::::::::::::#%%%%%%%%%%%%%%%+++++++++++++++++++++++++++++++++@@@@
@@@=:::::::::::::::::::::::::::::%%%%%%%%********#%%%%%%%++++++++++++++++++++++++++++++@@@
@@@::::::::::::::::::::::::::::%%%%%#*****************#%%%%*++++++++++++++++++++++++++++@@
@@:::::::::::::::::::::::::::%%%%%+++++++++++++++++++++++%%%%++++++++++++++++++++++++++++@
@@::::::::::::::::::::::::::%%%%+++++++++++++++++++++++++++%%%#++++++++++++++++++++++++++@
@:::::::::::::::::=::::::::%%%*+++++++++++++++++++++++++++++%%%*+++++++++++++++++++++++++@
@:::::::::::::::::::::::::%%%%+++++++++++++++++++++++++++++++%%%++++++++++++++++++++++++++
=::::::::::::::::::::::::#%%%================================+%%%+++++++++++++++++++++++++
=::::::::::::::::::::::::%%@@=================================@@%+++++++++++++++++++++++++
:::::::::::::::::::::::::%%@@=================================@@%+++++++++++++++++++++++++
@:::::::::::::::::::::::::@@@*===============================%%@++++++++++++++++++++++++++
@:::::::::::::::::::::::::=@@@::::::::::::::::::::::::::::::+%%@+++++++++++++++++++++++++@
@@:::::::::::::::::::::::::#@@@::::::::::::::::::::::::::::*%%@++++++++++++++++++++++++++@
@@:::::::::::::::::::::::::::@@@@*:::::::::::::::::::::::%%%%*++++++++++++++++++++++++++#@
@@@:::::::::::::::::::::::::::#@@@%#:::::::::::::::::::%%%%%++++++++++++++++++++++++++++@@
@@@:::::::::::::::::::::::::::::=@@@%%%#:::::::::::#%%%%%=:++++++++++++++++++++++++++++@@@
@@@@:::::::::::::::::::::::::::::::::@%%%%%%%%%%%%%%%#:::+++++++++++++++++++++++++++++@@@@
@@@@@:::::::::::::::::::::::::::::::::::::::::::::::::::+++++++++++++++++++++++++++++@@@@@
@@@@@@=::::::::::::::::::::::::::::::::::::::::::::::::+++++++++++++++++++++++++++++@@@@@@
@@@@@@@@::::::::::::::::::::::::::::::::::::::::::::::++++++++++++++++++++++++++++*@@@@@@@
@@@@@@@@@+::::::::::::::::::::::::::::::::::::::::::+++++++++++++++++++++++++++++@@@@@@@@@
@@@@@@@@@@@::::::::::::::::::::::::::::::::::::::::++++++++++++++++++++++++++++@@@@@@@@@@@
@@@@@@@@@@@@@+:::::::::::::::::::::::::::::::::::=+++++++++++++++++++++++++++@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@::::::::::::::::::::::::::::::::+++++++++++++++++++++++++++@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@=::::::::::::::::::::::::::::+++++++++++++++++++++++++@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@:::::::::::::::::::::::=+++++++++++++++++++++++@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@=:::::::::::::::::++++++++++++++++++++@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@::::::::::::++++++++++++++++@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@