Use to cat an image to the terminal
Project description
CatImage
Cat an image to the terminal.
- Install Single Script
- Install With PIP
- Example
- How To Use
- Language information
- Install Python on Windows
- Install Python on Linux
- How to run
- How to update, build and publish
- Download
- Community Files
- Screenshots
Install Single Script
Wget
wget -O /usr/bin/catimage https://raw.githubusercontent.com/FHPythonUtils/CatImage/master/catimage.py && sudo chmod 774 /usr/bin/catimage
Curl
curl -o /usr/bin/catimage https://raw.githubusercontent.com/FHPythonUtils/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 [-h] [-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
-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
How to update, build and publish
- Ensure you have installed the following dependencies
Linux
wget dephell.org/install | python3.8 wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python3.8
Windows(wget dephell.org/install -UseBasicParsing).Content | python (wget https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py -UseBasicParsing).Content | python
- Use poetry for the heavy lifting and dephell to generate requirements
poetry update dephell deps convert
- Build/ Publish
poetry build poetry publish
orpoetry publish --build
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/FHPythonUtils/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
Community Files
License
MIT License Copyright (c) FredHappyface (See the License for more information.)
Changelog
See the Changelog for more information.
Code of Conduct
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make participation in our project and our community a harassment-free experience for everyone. Please see the Code of Conduct for more information.
Contributing
Contributions are welcome, please see the Contributing Guidelines for more information.
Security
Thank you for improving the security of the project, please see the Security Policy 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.5.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a1192345695c7d2c555d671c9abd4b91e6de7ce3092c6cb8bf5e3e29d824c7c8 |
|
MD5 | 42ab4b57aa99edb126e8866c47c05797 |
|
BLAKE2b-256 | 1c7e0ba14ee13fef30a93bb39c4c96f92c0bcaa155fe11c788eb43d7a46e3031 |