Metadata-Version: 2.1
Name: img2text
Version: 0.0.2
Summary: A lightweight module to generate colorful ascii art from images
Home-page: https://github.com/hmiladhia/img2text
Author: Dhia HMILA
Author-email: dhiahmila@gmail.com
License: MIT
Description: # img2text
        
        A lightweight module to generate colorful ascii art from images
        
        To install img2text:
        ```python
        pip install img2text 
        ```
        
        ## How To Use
        Let's use the python logo as reference:
        
        ![Python Logo](https://raw.githubusercontent.com/hmiladhia/img2text/master/data/python.png)
        
        To generate an ascii image
        ```python
        from img2text import img_to_ascii
        
        ascii_img = img_to_ascii('data/python.png', width=80)
        print(ascii_img)
        ```
        
        We obtain the following:
        
        ![First Generated Image](https://raw.githubusercontent.com/hmiladhia/img2text/master/data/gen1.png)
        
        ### Adding Color
        We can customize this further by adding color (to be shown in the console):
         ```python
        from img2text import img_to_ascii
        
        ascii_img = img_to_ascii('data/python.png', width=80, colorful=True)
        print(ascii_img)
        ```
        
        We obtain the following:
        
        ![Second Generated Image](https://raw.githubusercontent.com/hmiladhia/img2text/master/data/gen2.png)
        
        ### Customizing Output
        We can reverse the intensity of the image by setting `reverse` to True
        
         ```python
        from img2text import img_to_ascii
        
        ascii_img = img_to_ascii('data/python.png', width=80, colorful=True, reverse=True)
        print(ascii_img)
        ```
        
        We obtain the following:
        
        ![Third Generated Image](https://raw.githubusercontent.com/hmiladhia/img2text/master/data/gen3.png)
        
        
        We can get a slightly brighter image by adding the `bright` option which sets the characters to bold:
         ```python
        from img2text import img_to_ascii
        
        ascii_img = img_to_ascii('data/python.png', width=80, colorful=True, reverse=True, bright=True)
        print(ascii_img)
        ```
        
        We obtain the following:
        
        ![Fourth Generated Image](https://raw.githubusercontent.com/hmiladhia/img2text/master/data/gen4.png)
        
        You can also change the character set by providing a custom string of characters that increase in intensity:
          ```python
        from img2text import img_to_ascii
        
        chars = r" ░▒▓█"
        
        ascii_img = img_to_ascii('data/python.png', width=80, colorful=True, bright=True, chars=chars)
        print(ascii_img)
        ```
        
        We obtain the following:
        
        ![Fourth Generated Image](https://raw.githubusercontent.com/hmiladhia/img2text/master/data/gen5.png)
        
        ### Additional Options
        - Customize the width and height by providing the number of columns/lines to use
        - Customize the aspect ratio by providing `ar_coef` coefficient. The default value is set to 2.4 
        but depending on the console you are using it might be interesting to try out values from [2, 3]
        - You can add a Background Color by setting `bg_color` to one of the following values:
            - BLACK
            - RED
            - GREEN
            - YELLOW
            - BLUE
            - MAGENTA
            - CYAN
            - WHITE
        
Keywords: ascii,art,ascii-art,image,text,color,colour
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
