Drawing image on terminal


License
MIT
Install
pip install dotshow==0.1.0

Documentation

dotshow

We generate image to text on terminal
It is made for terminal (CLI) to show image.
When we want to see image on python  linux server, 
we have to save image or use jupyter notebook.
To overcome those problem, I made this package.

To see thumnail of the image, we can use cv2.imshow in local environment.
However, it is impossible for server ssh terminal.
It is simple thumnail printer using python.

Example

We can print images like down below.

원본 이미지

before

dotshow

dotshow

colorshow

colorshow

How to use

Git cloning on your repository

pip install dotshow

import package on python

Draw image on terminal by putting path

from dotshow import loadshow
loadshow(<img-path>) # run the code (drawing a color image, default=color)
loadshow(<img-path>, color=False) # run the code (drawing a gray image)

Draw image on terminal by OpenCV2 array

import cv2
from dotshow import dotshow, colorshow
img = cv2.imread(<img-path>)
dotshow(img) # run the code (drawing a gray image)
colorshow(img) # run the code (drawing a color image)

Draw image on terminal by PIL Image

import numpy as np
from PIL import Image
from dotshow import dotshow, colorshow
img = np.array(Image.open(<img-path>))
dotshow(img) # run the code (drawing a gray image)
colorshow(img) # run the code (drawing a color image)

Parameters

loadshow(
    gray = True[default / bool]
    size = 7 [default / 0 ~ 10]
)
dotshow(
    gray = True[default]
    size = 7 [default / 0 ~ 10]
)
colorshow(
    size = 7 [default / 0 ~ 10]
)

gray - if your image is not interpretable, give gray parater False
size - if your image is too big in your terminal, reduce size using this parameter
  • If you use low size parameter, image will undersampled too much and it will decrease image quality.
  • If you use big size parameter, the terminal cannot describe image because the terminal is too small.