Skip to content

Latest commit

 

History

History
77 lines (56 loc) · 3.32 KB

Readme.md

File metadata and controls

77 lines (56 loc) · 3.32 KB

What is Catto

Catto is a command line program that downloads random cute animal images, gifs based on your category choice. This app is written in Python and uses Typer command line framework.

Installation

Catto can be directly installed using pip package manager or Poetry package manager using git:

Python Version Requirements

Python version: 3.10 or above is required.

Pip

pip3 install git+https://github.com/KortaPo/Catto.git

Poetry

poetry add git+https://github.com/KortaPo/Catto.git

Catto Usage

Catto has two ways to download images:

1.) Manual

catto download --category cats --amount 3 --path ./my_directory_where_the_images_would_be_saved

The above command will download 3 cute and random images of cats ( based on your choice ) to the directory which you provided.

Let's dissect the above command a bit more:

  • --category: This parameter takes the specific type of animal's image you wish to download.
  • --amount: This parameter takes the amount of images of the specific animal that would be downloaded.
  • --path: This parameter takes the path to the directory, where catto will download the random images.

This is the simplest and the fastest way to download your images using catto.

Download Command Output

2.) Interactive

catto interactive

This command will start an interactive catto session, that will prompt you with a series of questions and choices, and based on your choices it will download your images. It has a fancy UI, and it is hard to explain through words, so try it yourself and see.

Interactive Command Live Output

Commands

Catto has the following commands:

  • catto --help - This command shows the help menu of catto.
  • catto download - Simple and a fast way to use catto to download images of your choice.
  • catto interactive - Run catto in an interactive session.
  • catto version - This command shows the current version of catto that is currently installed.
  • catto status - This command shows all the status of all the API endpoints used by catto to search for images.
  • catto show-all-categories - This command shows all the animal categories supported by catto currently.
  • catto logo - This command shows the logo of catto in an animated way.

Note

Currently, catto will download the images in <selected-animal>-image-<random-hex-number> format.

For example: cats-image-cdf79775.

The reason for this feature is that they can be easily distinguished between different animal types and this allows make sure that the images almost always have a unique random hex number.

Credits

Well, this project is entirely free and open-source, if you want, you can certainly use it in your own projects.

If you like this project, you can add a GitHub star to show your appreciation, and you can credit me in your project.

Thanks :) Have a nice day!