Skip to main content

Python terminal image renderer

Project description

Imgrender: Python Terminal Image Viewer

Terminal image viewer in python, inspired by A piece of software designed to render images on the linux/bash command line. It can either be used as a CLI or as a python library. It should work on most modern terminals, including mobaxterm for windows and jupyter notebooks.


to Install imgrender, run pip install imgrender


Command Line

usage: imgrender [-h] [--width WIDTH] [--height HEIGHT] path

Render images on the command line

positional arguments:
  path             the image path

optional arguments:
  -h, --help       show this help message and exit
  --width WIDTH    width of the rendered image (default 60 pixels)
  --height HEIGHT  height of the rendered image (default 60 pixels)

Python Library

Simply import the render function from the imgrender library. The function has two arguments, the image path (positional), and the scale parameteter (keyword), which takes a tuple with two integer (height, width)

for instance:

In [1]: from imgrender import render

In [2]: render('frog.jpg', scale=(40, 60))
(this will render the image stored in 'frog.jpg' with 40x60 pixels)

The render function can be called without passing in a scale argument, this will use the default scale parameters of (60, 60)


below is an image of the city of Portsmouth generated as a 60x60 visualization.


And here is the original image


Finally, here is the same imaged visualised as 250x250 pixels


Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

imgrender-0.0.4.tar.gz (2.9 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page