term-image-qpython 0.7.2.1

This project is a branch of term-image on QPython.

Quick Start

Creating an instance

1. Initialize with a file path:

   from term_image.image import from_file
   
   image = from_file("path/to/image.png")
   

2. Initialize with a URL:

   from term_image.image import from_url
   
   image = from_url("https://www.example.com/image.png")
   

3. Initialize with a PIL (Pillow) image instance:

   from PIL import Image
   from term_image.image import AutoImage
   
   img = Image.open("path/to/image.png")
   image = AutoImage(img)
   

Drawing/Displaying an Image

There are two basic ways to draw an image to the terminal screen:

1. Using the draw() method:

   image.draw()
   

   NOTE: draw() has various parameters for render formatting.

2. Using print() with an image render output:

   print(image)  # without formatting
   # OR
   print(f"{image:>200.^100#ffffff}")  # with formatting
   

For animated images, only the former animates the output, the latter only draws the current frame.

See the tutorial for a more detailed introduction.

Usage

🚧 Under Construction - There will most likely be incompatible changes between minor versions of version zero!

If you want to use this library in a project while it's still on version zero, ensure you pin the dependency to a specific minor version e.g >=0.4,<0.5.

See the docs for the User Guide and API Reference.