Skip to main content

ASCIIDEIA

PyPI version License: MIT

ASCII Art Media Converter, Player & Renderer — Python Package

A Python package for converting images and videos to ASCII art with multiple color modes, rendering algorithms, and export capabilities. This is the lightweight, automation-friendly version of the full ASCIIDEIA tool, designed for integration into pipelines, scripts, and other applications.

What it does

ASCIIDEIA converts images and videos into ASCII art with real-time terminal playback, interactive controls, and standard media rendering (PNG/MP4 export). It supports multiple color modes, character algorithms, render modes, and background options.

Supported formats:

  • Images: PNG, JPG, JPEG, BMP, WebP, TIFF, TIF, ICO, PPM, PGM, PBM
  • Video: MP4, AVI, MKV, MOV, WebM, FLV, WMV, M4V, MPG, MPEG, 3GP, OGV, GIF
  • URLs: YouTube and TikTok (requires yt-dlp)

Installation

pip install asciideia

Requirements: Python 3.8+, OpenCV, NumPy, Pillow. FFmpeg optional (required for video rendering and audio features).

Usage

As a Python Library

import asciideia

# Convert an image to ASCII string
ascii_art = asciideia.convert_image("photo.png", color="colored", algo="chars", bg="dark")

# Convert a video frame (numpy array) to ASCII
ascii_art = asciideia.convert_frame(frame, width=120, color="colored", algo="blocks")

# Render image to PNG file
out_path = asciideia.render_image(
    "photo.png",
    output_dir="./output",
    color="colored",
    algo="chars",
    render_mode="modern",
    bg="dark"
)

# Render video to MP4 file
out_path = asciideia.render_video(
    "clip.mp4",
    output_dir="./output",
    color="colored",
    algo="chars",
    render_mode="modern",
    bg="dark"
)

# Get video metadata
meta = asciideia.get_video_metadata("clip.mp4")

# Check if video has audio
has_audio = asciideia.has_audio_track("clip.mp4")

Command Line

# Interactive mode
asciideia

# Image to terminal
asciideia image photo.png

# Video to terminal
asciideia video clip.mp4

# With options
asciideia image photo.png color bw algo blocks bg none

# Render to file
asciideia image photo.png render ./output
asciideia video clip.mp4 color colored algo chars rm retro bg dark r ./output

# Show help
asciideia help

Options

Flag Aliases Values Default
color c, colour colored, bw, gray colored
algo a, algorithm chars, blocks, dots chars
render r folder path (play in terminal)
render_mode rm, rendition modern, retro modern
bg background dark, none dark

GitHub Repository

For the full-featured interactive application and source code: https://github.com/HAKORADev/ASCIIDEIA

License

MIT License

Metadata

Release files for asciideia 0.0.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for asciideia 0.0.1
File Size Uploaded Provenance
asciideia-0.0.1.tar.gz 16.5 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for asciideia 0.0.1
File Interpreter ABI Platform
asciideia-0.0.1-py3-none-any.whl Python 3 none any Details

Total release size: 35.9 kB

Release files / asciideia-0.0.1.tar.gz

Download URL asciideia-0.0.1.tar.gz
Size 16.5 kB
Tags Source
SHA-256 checksum
How to use checksums
58a584026693b514603e642f0321b47d3f869fe7780c236e8e415c77987d8253
BLAKE2b-256 checksum
How to use checksums
2b398e5b0cc6145a16169994e56e9f6816d96aa94bab7833835b149dfb88466d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Release files / asciideia-0.0.1-py3-none-any.whl

Download URL asciideia-0.0.1-py3-none-any.whl
Size 19.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5eaba56fbb345d607033f46dd857207fa7870a5daa38d7842bdf398f52fb3d71
BLAKE2b-256 checksum
How to use checksums
68fde5e3d85c9d88d8c5aafbb5406fff53c57587ac642e89ec7678b79e7f807c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.13

Security for asciideia 0.0.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

0.0.1 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page