Use to cat an image to the terminal
Project description
Python.CatImage
New Icon?
Install Single Script
Wget
wget -O /usr/bin/catimage https://raw.githubusercontent.com/FredHappyface/Python.CatImage/master/catimage.py && sudo chmod 774 /usr/bin/catimage
Curl
curl -o /usr/bin/catimage https://raw.githubusercontent.com/FredHappyface/Python.CatImage/master/catimage.py && sudo chmod 774 /usr/bin/catimage
Install With PIP
pip install catimage
Head to https://pypi.org/project/catimage/ for more info
Example
Original Image:
Greyscale Image:
./catimage.py readme-assets/screenshots/desktop/example-0.png -g
Regular Definition Image:
./catimage.py readme-assets/screenshots/desktop/example-0.png -r -t
Regular Definition Image with '@':
./catimage.py readme-assets/screenshots/desktop/example-0.png -r -c @ -t
HD Image:
./catimage.py readme-assets/screenshots/desktop/example-0.png -t
HD Image with right half block:
./catimage.py readme-assets/screenshots/desktop/example-0.png -c $'\u2590' -t
HD Image True Colour:
./catimage.py readme-assets/screenshots/desktop/example-0.png
How To Use
Use to cat an image to the terminal, see the help text below for more information on using this tool from the command line:
usage: catimage.py [-h] [--gui] [-u] [-b] [-c Char] [-t] [-g | -r] Image
Cat an image to the terminal
positional arguments:
Image Image file or url
optional arguments:
-h, --help show this help message and exit
--gui Start program as a GUI. Note: Has a dumb terminal
-u, --url Image is a URL
-b, --big Big image
-c Char, --char Char Char to use in colour print use $'chr' for escaped chars
-t, --disable-truecolour
Disable output in truecolour
Choose one of the following:
Use the following arguments to change the look of the image
-g, --greyscale Output image in greyscale (best for terminals that cannot handle ANSI)
-r, --regular Output image in regular definition
GUI
Use the --cli2gui flag to launch a GUI
Alternatively, import into your project and use:
def generateHDColour(imageName, maxLen, trueColour=True, char="\u2584"):
"""Iterate through image pixels to make a printable string
Args:
imageName (str): path of the image on the filesystem (relative of
absolute)
maxLen (int): maximum of width and height in chars
trueColour (bool, optional): print in true colour. Defaults to True.
char (str, optional): use this char for each pixel. Defaults to "\u2584".
Returns:
str: string to print
"""
def generateColour(imageName, maxLen, trueColour=True, char="\u2588"):
"""Iterate through all of the pixels in an image and construct a printable
string
Args:
imageName (str): path of the image on the filesystem (relative of
absolute)
maxLen (int): maximum of width and height in chars
trueColour (bool, optional): print in true colour. Defaults to True.
char (str, optional): use this char for each pixel. Defaults to "\u2588".
Returns:
str: string to print
"""
def generateGreyscale(imageName, maxLen):
"""Iterate through image pixels to make a printable string
Args:
imageName (str): path of the image on the filesystem (relative of
absolute)
maxLen (int): maximum of width and height in chars
Returns:
str: string to print
"""
Language information
Built for
This program has been written for Python 3 and has been tested with Python version 3.8.0 https://www.python.org/downloads/release/python-380/.
Install Python on Windows
Chocolatey
choco install python
Download
To install Python, go to https://www.python.org/ and download the latest version.
Install Python on Linux
Apt
sudo apt install python3.8
How to run
With VSCode
- Open the .py file in vscode
- Ensure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.8)
- Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)
From the Terminal
./[file].py
Changelog
See the CHANGELOG for more information.
Download
Clone
Using The Command Line
- Press the Clone or download button in the top right
- Copy the URL (link)
- Open the command line and change directory to where you wish to clone to
- Type 'git clone' followed by URL in step 2
$ git clone https://github.com/FredHappyface/Python.CatImage
More information can be found at https://help.github.com/en/articles/cloning-a-repository
Using GitHub Desktop
- Press the Clone or download button in the top right
- Click open in desktop
- Choose the path for where you want and click Clone
More information can be found at https://help.github.com/en/desktop/contributing-to-projects/cloning-a-repository-from-github-to-github-desktop
Download Zip File
- Download this GitHub repository
- Extract the zip archive
- Copy/ move to the desired location
Licence
MIT License Copyright (c) FredHappyface (See the LICENSE for more information.)
Screenshots
Desktop
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for catimage-2020.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e731786796e8a7690263577faf1d4778306d184b2102d88514ff773250f46ea8 |
|
MD5 | 867cec9aabacd9fd396c8cdd9602bf11 |
|
BLAKE2b-256 | cfe75eeaa06344154c37d977f63084bc747e83e8c557c10b872337348b2690b2 |