Display Images in your terminal with python

Last update: Dec 30, 2022

Overview

`Img`

Display Images in your terminal with python

Installation

The package can be installed via pip

pip install terminal-img

Quick Start

The library is really simple to get started with. Here's is an example of how you display an image

from image import DrawImage

image = DrawImage("image.png")

You can also use a url if you dont have the file locally stored

image = DrawImage.from_url("url")

Methods

`image.DrawImage`

filename: The name of the file containing the image
size(Optional[Tuple]) : The size of the image to be displayed. Default: 24, 24
draw: Whether to draw on creating an instance or wait for the user to call the function

`image.DrawImage.from_url`

url : The url of the image
size(Optional[Tuple]) : The size of the image to be displayed. Default: 24, 24
draw: Whether to draw on creating an instance or wait for the user to call the function

Comments

Storing images in memory instead of on disk.
Discussed in https://github.com/pranavbaburaj/img/discussions/9

^{Originally posted by AnonymouX47 October 5, 2021} This applies in three ways:

A DrawImage instance holds a reference to a PIL image instead of a filepath.

This way, the file doesn't have to be read from disk every time the image is to be drawn.

This will easily allow support for cases where an image is being processed and only currently exists in memory e.g PIL image objects and more.

Increases the speed of repeated image drawing.

Of course, this also comes at the cost of memory but i think the trade-off is worth it.

Makes the library usable in an environment where file writes are either not possible or not wanted (maybe on some servers or cloud-based systems).

The other points below are hinged upon this one.

Images downloaded from URLs are stored as PIL image objects instead of files.

This is dependent upon and shares the benefits/liabilities of (1.).

Frames of GIFs are stored as PIL images instead of files.

This is dependent upon and shares the benefits/liabilities of (1.).

I think this is good because the frames are only used once, so why take them from memory to disk, then back to memory.

Drastically increases speed.

Reduces amount of disk read/write.

Let me know what you think... I've already checked (and tested) and I'm sure 2 and 3 are possible.
opened by pranavbaburaj 16
CLI
A CLI would be a nice addon to the project. So, user can try out printing images. The current cli need to be polished.

CLI design.

img <command> <filename> --param=value
opened by pranavbaburaj 9
Discrepancies in image colour space interpretation.

Here: https://github.com/pranavbaburaj/img/blob/1309c087b7b7aa5ade183c2800a0789d1529b6ab/image.py#L73 conversion to RGB is not enabled by default but here: https://github.com/pranavbaburaj/img/blob/1309c087b7b7aa5ade183c2800a0789d1529b6ab/image.py#L93 RGB values are expected.

I actually ran into this bug while trying to print a PNG image with a single (alpha) chanel. Here: https://github.com/pranavbaburaj/img/blob/1309c087b7b7aa5ade183c2800a0789d1529b6ab/image.py#L83 pixel_values was just a tuple of integers (0s and 1s), representing the opacity of each pixel.

So, here: https://github.com/pranavbaburaj/img/blob/1309c087b7b7aa5ade183c2800a0789d1529b6ab/image.py#L90-L92 continue was always executed on every iteration.

Therefore, there was no output at all! As expected, the image could only be displayed when I set convert_to_rgb = True when calling draw_image().

I think conversion to RGB should be made the default and then support for other colour spaces can be added later on.
bug

opened by AnonymouX47 5
Disable image draw upon instantiation.

https://github.com/pranavbaburaj/img/blob/1309c087b7b7aa5ade183c2800a0789d1529b6ab/image.py#L53-L54

I feel it's rather uncommon and unintuitive for object initialization (class instantiation) to have immediate size effects (e.g printing to the terminal in this case). For instance, PIL doesn't display an image when you create a new image object, you have to explicitly call a method to do that... among so many others.

ObJect initialization has it's purpose... I think drawing the image will be better as a completely explicit action by calling the draw_image() method.

This concerns both the __init__() and from_url() methods and the draw parameter in both.

opened by AnonymouX47 4
Redesign
Improved image drawing.

Rewrote GIF display method.

Added from_file()

Added input type checks.

Added support for PIL image input.

Removed __validate_input()

The commit messages contain much fuller details of the changes.
opened by AnonymouX47 3
Convert all color spaces to RGB (fixed #7)

See description of #7. Closes #7

Images in other color spaces are now converted to RGB. It's no longer optional since the ANSI color codes use RGB only.

opened by AnonymouX47 3
Created requirements.txt
Related Issue

Closes: #[issue number that will be closed through this PR]

Describe the changes you've made

Checklist:

[ ] My code follows the style guidelines of this project.

[ ] I have performed a self-review of my own code.

[ ] I have commented my code, particularly in hard-to-understand areas.

[ ] I have made corresponding changes to the documentation.

[ ] My changes generate no new warnings.

Screenshots

| Original | Updated | | :---------------------: | :------------------------: | | original screenshot | updated screenshot |
opened by silvershade1337 2
build(deps): bump pillow from 8.3.2 to 9.0.0
Bumps pillow from 8.3.2 to 9.0.0.

Release notes

Sourced from pillow's releases.

9.0.0

https://pillow.readthedocs.io/en/stable/releasenotes/9.0.0.html

Changes

Restrict builtins for ImageMath.eval() #5923 [@radarhere]

Ensure JpegImagePlugin stops at the end of a truncated file #5921 [@radarhere]

Fixed ImagePath.Path array handling #5920 [@radarhere]

Remove consecutive duplicate tiles that only differ by their offset #5919 [@radarhere]

Removed redundant part of condition #5915 [@radarhere]

Explicitly enable strip chopping for large uncompressed TIFFs #5517 [@kmilos]

Use the Windows method to get TCL functions on Cygwin #5807 [@DWesl]

Changed error type to allow for incremental WebP parsing #5404 [@radarhere]

Improved I;16 operations on big endian #5901 [@radarhere]

Ensure that BMP pixel data offset does not ignore palette #5899 [@radarhere]

Limit quantized palette to number of colors #5879 [@radarhere]

Use latin1 encoding to decode bytes #5870 [@radarhere]

Fixed palette index for zeroed color in FASTOCTREE quantize #5869 [@radarhere]

When saving RGBA to GIF, make use of first transparent palette entry #5859 [@radarhere]

Pass SAMPLEFORMAT to libtiff #5848 [@radarhere]

Added rounding when converting P and PA #5824 [@radarhere]

Improved putdata() documentation and data handling #5910 [@radarhere]

Exclude carriage return in PDF regex to help prevent ReDoS #5912 [@radarhere]

Image.NONE is only used for resampling and dithers #5908 [@radarhere]

Fixed freeing pointer in ImageDraw.Outline.transform #5909 [@radarhere]

Add Tidelift alignment action and badge #5763 [@aclark4life]

Replaced further direct invocations of setup.py #5906 [@radarhere]

Added ImageShow support for xdg-open #5897 [@m-shinder]

Fixed typo #5902 [@radarhere]

Switched from deprecated "setup.py install" to "pip install ." #5896 [@radarhere]

Support 16-bit grayscale ImageQt conversion #5856 [@cmbruns]

Fixed raising OSError in _safe_read when size is greater than SAFEBLOCK #5872 [@radarhere]

Convert subsequent GIF frames to RGB or RGBA #5857 [@radarhere]

WebP: Fix memory leak during decoding on failure #5798 [@ilai-deutel]

Do not prematurely return in ImageFile when saving to stdout #5665 [@infmagic2047]

Added support for top right and bottom right TGA orientations #5829 [@radarhere]

Corrected ICNS file length in header #5845 [@radarhere]

Block tile TIFF tags when saving #5839 [@radarhere]

Added line width argument to ImageDraw polygon #5694 [@radarhere]

Do not redeclare class each time when converting to NumPy #5844 [@radarhere]

Only prevent repeated polygon pixels when drawing with transparency #5835 [@radarhere]

Fix pushes_fd method signature #5833 [@hoodmane]

Add support for pickling TrueType fonts #5826 [@hugovk]

Only prefer command line tools SDK on macOS over default MacOSX SDK #5828 [@radarhere]

Fix compilation on 64-bit Termux #5793 [@landfillbaby]

Replace 'setup.py sdist' with '-m build --sdist' #5785 [@hugovk]

Use declarative package configuration #5784 [@hugovk]

Use title for display in ImageShow #5788 [@radarhere]

Fix for PyQt6 #5775 [@hugovk]

... (truncated)

Changelog

Sourced from pillow's changelog.

9.0.0 (2022-01-02)

Restrict builtins for ImageMath.eval(). CVE-2022-22817 #5923 [radarhere]

Ensure JpegImagePlugin stops at the end of a truncated file #5921 [radarhere]

Fixed ImagePath.Path array handling. CVE-2022-22815, CVE-2022-22816 #5920 [radarhere]

Remove consecutive duplicate tiles that only differ by their offset #5919 [radarhere]

Improved I;16 operations on big endian #5901 [radarhere]

Limit quantized palette to number of colors #5879 [radarhere]

Fixed palette index for zeroed color in FASTOCTREE quantize #5869 [radarhere]

When saving RGBA to GIF, make use of first transparent palette entry #5859 [radarhere]

Pass SAMPLEFORMAT to libtiff #5848 [radarhere]

Added rounding when converting P and PA #5824 [radarhere]

Improved putdata() documentation and data handling #5910 [radarhere]

Exclude carriage return in PDF regex to help prevent ReDoS #5912 [hugovk]

Fixed freeing pointer in ImageDraw.Outline.transform #5909 [radarhere]

Added ImageShow support for xdg-open #5897 [m-shinder, radarhere]

Support 16-bit grayscale ImageQt conversion #5856 [cmbruns, radarhere]

Convert subsequent GIF frames to RGB or RGBA #5857 [radarhere]

... (truncated)

Commits

82541b6 9.0.0 version bump

cae5ac4 Merge pull request #5924 from radarhere/cves

ed4cf78 CVEs TBD

d7f60d1 Merge pull request #5923 from radarhere/imagemath_eval

8531b01 Restrict builtins for ImageMath.eval

1efb1d9 Merge pull request #5922 from radarhere/releasenotes

f6c7871 Added release notes for #5919, #5920 and #5921

032d2dc Update CHANGES.rst [ci skip]

baae9ec Merge pull request #5921 from radarhere/jpeg_eoi

1059eb5 If appended EOI did not work, do not keep trying

Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 1
Fixed Bug
Fixed Bugs

I found a small bug wjile checking the actions. Its was just a simple mistake with the variable spelling of your code.

[X] Fixed Variable error
opened by mjvbz 1
build(deps): bump pillow from 9.0.0 to 9.0.1
Bumps pillow from 9.0.0 to 9.0.1.

Release notes

Sourced from pillow's releases.

9.0.1

https://pillow.readthedocs.io/en/stable/releasenotes/9.0.1.html

Changes

In show_file, use os.remove to remove temporary images. CVE-2022-24303 #6010 [@radarhere, @hugovk]

Restrict builtins within lambdas for ImageMath.eval. CVE-2022-22817 #6009 [radarhere]

Changelog

Sourced from pillow's changelog.

9.0.1 (2022-02-03)

In show_file, use os.remove to remove temporary images. CVE-2022-24303 #6010 [radarhere, hugovk]

Restrict builtins within lambdas for ImageMath.eval. CVE-2022-22817 #6009 [radarhere]

Commits

6deac9e 9.0.1 version bump

c04d812 Update CHANGES.rst [ci skip]

4fabec3 Added release notes for 9.0.1

02affaa Added delay after opening image with xdg-open

ca0b585 Updated formatting

427221e In show_file, use os.remove to remove temporary images

c930be0 Restrict builtins within lambdas for ImageMath.eval

75b69dd Dont need to pin for GHA

cd938a7 Autolink CWE numbers with sphinx-issues

2e9c461 Add CVE IDs

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

@dependabot use these labels will set the current labels as the default for future PRs for this repo and language

@dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language

@dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language

@dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language

You can disable automated security fix PRs for this repo from the Security Alerts page.

dependencies
opened by dependabot[bot] 0
Create pylint.yml
Related Issue

Closes: #[issue number that will be closed through this PR]

Describe the changes you've made

Checklist:

[ ] My code follows the style guidelines of this project.

[ ] I have performed a self-review of my own code.

[ ] I have commented my code, particularly in hard-to-understand areas.

[ ] I have made corresponding changes to the documentation.

[ ] My changes generate no new warnings.

Screenshots

| Original | Updated | | :---------------------: | :------------------------: | | original screenshot | updated screenshot |
opened by pranavbaburaj 0
Prints out distorted colors on Mac terminal
Describe the bug DrawImage.draw_image() seems to fail when using the default Mac terminal. It almost seems that colors are printed at random. However, the output from PyCharm terminal had no issue printing the image.

To Reproduce Using Mac terminal. I ran the following lines of code: from image import DrawImage pfp = DrawImage.from_url(url-to-image, (32, 32)) pfp.draw_image()

View from Mac default terminal

View from PyCharm terminal

Device: MacBookPro15

OS: macOS Catalina 10.15.7 19H1417 x86_64
opened by surety 6

Releases(v0.0.3)

v0.0.3(Feb 6, 2022)

Update pillow to the latest version (9.0.0)
Source code(tar.gz)
Source code(zip)
v0.0.2(Oct 14, 2021)
Changelog

Changed the library design. DrawImage provides from_url and from_file which returns a DrawImage object. evoke the draw_image method to print the image to the console

from image import DrawImage image_object = DrawImage.from_url("url") image_object.draw_image()

Add GIF support

Source code(tar.gz)
Source code(zip)
0.0.1(Sep 24, 2021)

The initial release of terminal-img. Can be installed via pip using pip install terminal-img
Source code(tar.gz)
Source code(zip)

Owner

Pranav Baburaj

I am @pranavbaburaj . I am 14 and I love programming...

GitHub Repository https://pranavbaburaj.github.io/img/

A Python-based Wordle solver and CLI player

Wordle A Python-based Wordle solver and CLI player This was created using Python 3.9.7. SPOILER ALERT: the data directory contains spoilers for upcomi

1 Jul 24, 2022

Colab-xterm allows you to open a terminal in a cell

colab-xterm Colab-xterm allows you to open a terminal in a cell. Usage Install package and load the extension !pip install git+https://github.com/popc

194 Dec 29, 2022

GitFun - A Simplified Automated CLI tool for GIT😃

GitFun A Simplified Automated CLI tool for GIT, It's for Lazy Developers and Newbies 😜 Table of contents GitFun Installation Usage Development Contri

8 Feb 22, 2022

⌨ Toward a more useful keyboard

Toward a more useful keyboard Steve Losh's Modern Space Cadet is an inspiration. It opened my eyes to the fact that there's a more useful keyboard hid

1.7k Jan 01, 2023

Fetch is use to get information about anything on the shell using Wikipedia.

Fetch Search wikipedia article on command line [Why This?] [Support the Project] [Installation] [Configuration] Why this? Fetch helps you to quickly l

340 Dec 18, 2022

Simple Python Library to display text with color in Python Terminal

pyTextColor v1.0 Introduction pyTextColor is a simple Python Library to display colorful outputs in Terminal, etc. Note: Your Terminal or any software

1 Jan 23, 2022

A Command Line Error Parser Built using Python.

"Stalk Overflow with debuggy" Error Parser Everything is done in Python so it's extremely easy to install and use. Supports Python 3. Debuggy is used

22 Nov 10, 2022

commandpack - A package of modules for working with commands, command packages, files with command packages.

commandpack Help the project financially: Donate: https://smartlegion.github.io/donate/ Yandex Money: https://yoomoney.ru/to/4100115206129186 PayPal:

4 Sep 04, 2021

Patool is a portable command line archive file manager

Patool Patool is an archive file manager. Various archive formats can be created, extracted, tested, listed, searched, repacked and compared with pato

318 Jan 04, 2023

A terminal utility to sort image files based on their characteristics.

About A terminal utility to sort image files based on their characteristics. Motivation This program was developed after I've realized that I had too

1 Dec 10, 2022

A simple command line chat app to communicate via the terminal.

A simple command line chat app to communicate via the terminal. I'm new to networking so sorry if some of my terminology or code is messed up.

1 Oct 26, 2021

Simple Digital Ocean CLI by python.

2 Jan 01, 2023

LSD (Linux Spotify Downloader) is a command line tool for downloading or rather recording content on Spotify.

7 Jun 21, 2022

Task-manager-CLI with Priority Modification

Task-manager-CLI with Priority Modification The functions for the app have been written in task.py file. 1. Install Node.js This project requires Node

1 Jan 21, 2022

Package installer for python

This is a package that adds a JSON file to your project that records all of the packages used in it and allows people to install it with a single command.

1 May 23, 2022

GetRepo-py is a command line client that queries GitHub API and searches repositories by given arguments

3 Feb 14, 2022

Install python modules from pypi from a previous date in history

pip-rewind is a command-line tool that can rewind pypi module versions (given as command-line arguments or read from a requirements.txt file) to a previous date in time.

4 Jul 03, 2021

Because sometimes you need to do it live

doitlive doitlive is a tool for live presentations in the terminal. It reads a file of shell commands and replays the commands in a fake terminal sess

3.2k Jan 09, 2023

Centauro - a command line tool with some network management functionality

Centauro Ferramenta de rede O Centauro é uma ferramenta de linha de comando com

1 Jan 01, 2022

Conditional Transformer Language Model for Controllable Generation

CTRL - A Conditional Transformer Language Model for Controllable Generation Authors: Nitish Shirish Keskar, Bryan McCann, Lav Varshney, Caiming Xiong,

1.7k Jan 05, 2023

Display Images in your terminal with python

Related tags

Overview

Img

Installation

Quick Start

Methods

image.DrawImage

image.DrawImage.from_url

Comments

Discussed in https://github.com/pranavbaburaj/img/discussions/9

Related Issue

Describe the changes you've made

Checklist:

Screenshots

9.0.0

Changes

9.0.0 (2022-01-02)

Fixed Bugs

9.0.1

Changes

9.0.1 (2022-02-03)

Related Issue

Describe the changes you've made

Checklist:

Screenshots

Releases(v0.0.3)

v0.0.3(Feb 6, 2022)

v0.0.2(Oct 14, 2021)

Changelog

0.0.1(Sep 24, 2021)

Owner

Pranav Baburaj

A Python-based Wordle solver and CLI player

Colab-xterm allows you to open a terminal in a cell

GitFun - A Simplified Automated CLI tool for GIT😃

⌨ Toward a more useful keyboard

Fetch is use to get information about anything on the shell using Wikipedia.

Simple Python Library to display text with color in Python Terminal

A Command Line Error Parser Built using Python.

commandpack - A package of modules for working with commands, command packages, files with command packages.

Patool is a portable command line archive file manager

A terminal utility to sort image files based on their characteristics.

A simple command line chat app to communicate via the terminal.

Simple Digital Ocean CLI by python.

LSD (Linux Spotify Downloader) is a command line tool for downloading or rather recording content on Spotify.

Task-manager-CLI with Priority Modification

Package installer for python

GetRepo-py is a command line client that queries GitHub API and searches repositories by given arguments

Install python modules from pypi from a previous date in history

Because sometimes you need to do it live

Centauro - a command line tool with some network management functionality

Conditional Transformer Language Model for Controllable Generation

`Img`

`image.DrawImage`

`image.DrawImage.from_url`