Metadata-Version: 2.1
Name: catimage
Version: 2020.4
Summary: Use to cat an image to the terminal
Home-page: https://github.com/FredHappyface/Python.CatImage
Author: FredHappyface
License: UNKNOWN
Description: [![Github top language](https://img.shields.io/github/languages/top/FredHappyface/Python.CatImage.svg?style=for-the-badge)](../../)
        [![Codacy grade](https://img.shields.io/codacy/grade/6b3bd2d2569f44dca74a391e905042ac.svg?style=for-the-badge)](https://www.codacy.com/manual/FredHappyface/Python.CatImage)
        [![Repository size](https://img.shields.io/github/repo-size/FredHappyface/Python.CatImage.svg?style=for-the-badge)](../../)
        [![Issues](https://img.shields.io/github/issues/FredHappyface/Python.CatImage.svg?style=for-the-badge)](../../issues)
        [![License](https://img.shields.io/github/license/FredHappyface/Python.CatImage.svg?style=for-the-badge)](/LICENSE.md)
        [![Commit activity](https://img.shields.io/github/commit-activity/m/FredHappyface/Python.CatImage.svg?style=for-the-badge)](../../commits/master)
        [![Last commit](https://img.shields.io/github/last-commit/FredHappyface/Python.CatImage.svg?style=for-the-badge)](../../commits/master)
        [![PyPI](https://img.shields.io/pypi/dm/catimage.svg?style=for-the-badge)](https://pypi.org/project/catimage/)
        
        # Python.CatImage
        
        <img src="readme-assets/icons/name.png" alt="Project Icon" width="750">
        
        New Icon?
        
        <img src="readme-assets/icons/name1.png" alt="Project Icon" width="750">
        
        ## Install Single Script
        ### Wget
        ```bash
        wget -O /usr/bin/catimage https://raw.githubusercontent.com/FredHappyface/Python.CatImage/master/catimage.py && sudo chmod 774 /usr/bin/catimage
        ```
        ### Curl
        ```bash
        curl -o /usr/bin/catimage https://raw.githubusercontent.com/FredHappyface/Python.CatImage/master/catimage.py && sudo chmod 774 /usr/bin/catimage
        ```
        
        ## Install With PIP
        
        ```python
        pip install catimage
        ```
        
        Head to https://pypi.org/project/catimage/ for more info
        
        
        ## Example
        Original Image:
        
        <img src="readme-assets/screenshots/desktop/example-0.png" alt="Screenshot 1" width="600">
        
        Greyscale Image:
        ```python
        ./catimage.py readme-assets/screenshots/desktop/example-0.png -g
        ```
        
        <img src="readme-assets/screenshots/desktop/example-1.png" alt="Screenshot 2" width="600">
        
        Regular Definition Image:
        ```python
        ./catimage.py readme-assets/screenshots/desktop/example-0.png -r -t
        ```
        
        <img src="readme-assets/screenshots/desktop/example-2.png" alt="Screenshot 3" width="600">
        
        Regular Definition Image with '@':
        ```python
        ./catimage.py readme-assets/screenshots/desktop/example-0.png -r -c @ -t
        ```
        
        <img src="readme-assets/screenshots/desktop/example-3.png" alt="Screenshot 4" width="600">
        
        HD Image:
        ```python
        ./catimage.py readme-assets/screenshots/desktop/example-0.png -t
        ```
        
        <img src="readme-assets/screenshots/desktop/example-4.png" alt="Screenshot 5" width="600">
        
        HD Image with right half block:
        ```python
        ./catimage.py readme-assets/screenshots/desktop/example-0.png -c $'\u2590' -t
        ```
        
        <img src="readme-assets/screenshots/desktop/example-5.png" alt="Screenshot 6" width="600">
        
        HD Image True Colour:
        ```python
        ./catimage.py readme-assets/screenshots/desktop/example-0.png
        ```
        
        <img src="readme-assets/screenshots/desktop/example-6.png" alt="Screenshot 7" width="600">
        
        ## 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:
        ```python
        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
        
        <div>
        <img src="readme-assets/screenshots/desktop/gui-0.png" alt="GUI 1" width="600">
        <img src="readme-assets/screenshots/desktop/gui-1.png" alt="GUI 2" width="600">
        </div>
        
        Alternatively, import into your project and use:
        
        ```python
        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
        ```powershell
        choco install python
        ```
        ### Download
        To install Python, go to <https://www.python.org/> and download the latest
        version.
        
        ## Install Python on Linux
        ### Apt
        ```bash
        sudo apt install python3.8
        ```
        
        ## How to run
        ### With VSCode
        1. Open the .py file in vscode
        2. Ensure a python 3.8 interpreter is selected (Ctrl+Shift+P > Python:Select Interpreter > Python 3.8)
        3. Run by pressing Ctrl+F5 (if you are prompted to install any modules, accept)
        ### From the Terminal
        ```bash
        ./[file].py
        ```
        
        
        
        ## Changelog
        See the [CHANGELOG](/CHANGELOG.md) for more information.
        
        
        ## Download
        ### Clone
        #### Using The Command Line
        1. Press the Clone or download button in the top right
        2. Copy the URL (link)
        3. Open the command line and change directory to where you wish to
        clone to
        4. Type 'git clone' followed by URL in step 2
        ```bash
        $ 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
        1. Press the Clone or download button in the top right
        2. Click open in desktop
        3. 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
        
        1. Download this GitHub repository
        2. Extract the zip archive
        3. Copy/ move to the desired location
        
        
        ## Licence
        MIT License
        Copyright (c) FredHappyface
        (See the [LICENSE](/LICENSE.md) for more information.)
        
        ## Screenshots
        
        ### Desktop
        <div>
        <img src="readme-assets/screenshots/desktop/screenshot-0.png" alt="Screenshot 1" width="600">
        <img src="readme-assets/screenshots/desktop/screenshot-1.png" alt="Screenshot 2" width="600">
        <img src="readme-assets/screenshots/desktop/screenshot-2.png" alt="Screenshot 3" width="600">
        </div>
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.0
Description-Content-Type: text/markdown
