Skip to main content

A CLI tool to convert images, GIFs, and videos to ASCII

Project description

🎨 ASCII Art CLI

Convert images, videos, and GIFs to ASCII art directly in your terminal! Supports color, background effects, and video/GIF playback.

🚀 Features

✔️ Image to ASCII conversion (JPG, PNG, etc.) ✔️ Video to ASCII playback (MP4, AVI, etc.) ✔️ GIF to ASCII animation (Animated GIF support) ✔️ Color & background options (--color, --bg) ✔️ Interactive mode (-i) for easy use ✔️ Docker support (No dependencies needed)


📦 Installation

🔹 1. Install Locally with Python

Requires Python 3.7+

pip install -r requirements.txt
python ascii_art.py -i

🔹 2. Run with Docker (No Dependencies Needed)

docker build -t ascii-art-cli .
docker run --rm -it -v "$(pwd):/app" ascii-art-cli -i

🎥 Usage Examples

1️⃣ Convert an Image to ASCII

python ascii_art.py my_image.jpg --color

2️⃣ Play a Video as ASCII

python ascii_art.py my_video.mp4 --color --fps 15

3️⃣ Play an Animated GIF as ASCII

python ascii_art.py my_animation.gif --color

4️⃣ Interactive Mode (Step-by-Step Selection)

python ascii_art.py -i

🛠️ Advanced Options

Option Description Default
--width Output ASCII width 100
--color Enable color output False
--bg Enable background color effects False
--fps Frame rate for videos 30
--output Save ASCII output to a file None

Example: Save ASCII output to a file

python ascii_art.py my_image.jpg --output=ascii_output.txt

🐫 Running Inside Docker

No Python installation needed! Just use Docker:

1️⃣ Build the Docker image

docker build -t ascii-art-cli .

2️⃣ Run an image through Docker

docker run --rm -it -v "$(pwd):/app" ascii-art-cli samples/vegeta.jpeg --color
docker run --rm -it -v "$(pwd):/app" ascii-art-cli samples/sangoku.png --color

3️⃣ Play a video in ASCII through Docker

docker run --rm -it -v "$(pwd):/app" ascii-art-cli samples/countdown.mp4 --fps 60 --color

4️⃣ Play an animated GIF in ASCII through Docker

docker run --rm -it -v "$(pwd):/app" ascii-art-cli samples/fusion.gif --color

🤖 Contributing

Feel free to fork, create a PR, or submit an issue!


📝 License

MIT License

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

artii-1.0.1.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

artii-1.0.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file artii-1.0.1.tar.gz.

File metadata

  • Download URL: artii-1.0.1.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.7

File hashes

Hashes for artii-1.0.1.tar.gz
Algorithm Hash digest
SHA256 72d4c9858d8081b7d80a4881f9f771f786f0914a1bfe7c50b7eab17ffb83908d
MD5 19ec031a4c35b52e9e3aa4c142ca2a68
BLAKE2b-256 154db465ac4c17d67de18d0d87aecf6f30948e35061ccc37b486ef3b7013cb4c

See more details on using hashes here.

File details

Details for the file artii-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: artii-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.7

File hashes

Hashes for artii-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c1e7eba2104736535c3524b723c8701b7ab704a500ea428be9140705df75a2f3
MD5 de64899cb920bc35636ef7bfa345a995
BLAKE2b-256 ddefe766db64d901a0987db6d68668233c70a52d33b157539760db9e5e267a45

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page