Skip to main content

A Python library and CLI tool for converting images and videos into ASCII art.

Project description

ASCII Art Python - Convert Images & Videos to Terminal Graphics

PyPI version Python versions PyPI Downloads License: MIT

ASCII Art Python is a powerful tool to transform your images and videos into ASCII art. Export your creations as text, images, or videos (with audio) and play them directly in your terminal.

Preview

Below is an example of an image featuring the Python logo:

                 ||||||*{{*||||||                 
             ///{{{****{{{{{{{{{{{\\              
             |{{//-\*{{{{{{{{{{{{{{{\             
            |*{*|   |{{{{{{{{{{{{{{{{|            
            |*{{{*-*{{{{{{{{{{{{{{{{{|            
             \{{{{{{{{{{{{{{{{{{{{{{{|            
        -----           /*{{{{{{{{{{{| -----      
   //{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |::::::\\  
 //{*****{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |::::::::\ 
-******{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| |:::::::::-
-{***{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{| .::::::::::-
-{**{{{{{{{{{{{{{{{{{{{{{{{{{{{{{{//  /:::::::::::
*{{{{{{{{{{{{{/-----------------    .:::::::::::::
-{{{{{{{{{{{//  .----------------:::::::::::::::::
-{{{{{{{{{{|  .......::::::::::::::::::::::::::::-
-{{{{{{{{{{| |.....::::::::::::::::::::::::::::::-
 |{{{{{{{{{| |....::::::::::::::::::::::::::::::/ 
 \\{{{{{{{{| |..:::::::::::::::::::::::::::::::/  
   \\-{{{{/| |::::::::::::-----------:::::---/    
            |:::::::::::.\----------\             
            |::::::::::::::::::::::::|            
            |::::::::::::::::::.:::::|            
            |::::::::::::::::|   |:::|            
             |::::::::::::::::\-//::|             
              \\::::::::::::::::::///             
                 |||||:::::::||||                 

And below, an example of a video featuring Nyan Cat:

Example with the Nyan Cat video played in a terminal.

Installation

pip install ascii-art-python

OpenCV Note: This module uses opencv-python-headless. To avoid conflicts with opencv-python, it is highly recommended to use a virtual environment (venv).

Quick Start

1. Command-Line Interface (CLI)

# Display an image in the terminal
aap-echo my_image.jpg -m full_mode
# Export a video to ASCII (.mp4)
aap-export my_video.mp4 result.mp4 -h 100

2. Python Usageimport ascii_art_python as aap

# Convert an image (Hybrid Mode)
img = aap.full_mode.Image.from_path("photo.jpg", width=500)
print(img)
# Play a video in the terminal (Edge-Detection Mode)
vid = aap.old_skool.Video("movie.mp4", fps=15)
vid.print_in_terminal()

Rendering Modes

  • New Skool: Density-based (classic shading).
  • Old Skool: Edge-detection based (line art style).
  • Full Mode: Hybrid combining sharp contours and shading.

Full Documentation

To check the complete API, class details, and advanced export options, visit: the doc.

License

Distributed under the MIT License. See LICENSE for more information.

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

ascii_art_python-2.1.0.tar.gz (301.7 kB view details)

Uploaded Source

Built Distribution

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

ascii_art_python-2.1.0-py3-none-any.whl (306.3 kB view details)

Uploaded Python 3

File details

Details for the file ascii_art_python-2.1.0.tar.gz.

File metadata

  • Download URL: ascii_art_python-2.1.0.tar.gz
  • Upload date:
  • Size: 301.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.4

File hashes

Hashes for ascii_art_python-2.1.0.tar.gz
Algorithm Hash digest
SHA256 e2b2f88f459c61ff4965d0d0d956b22d3c91d4ae4f17f592bced893316d9e5b2
MD5 2dd079e05a5f7cea320c7aadebeb82fc
BLAKE2b-256 0689da226ffa6f8c0c9ddbd871f886ca814b13bb88161699f3a092480819b770

See more details on using hashes here.

File details

Details for the file ascii_art_python-2.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for ascii_art_python-2.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2667cff1c89fab87c82c00bc7f0d39f00bb6671ae7a7bc999a9b1876d7a2a66f
MD5 859124d5fb8edd1ba13a5df32722b6f2
BLAKE2b-256 2579155d7301a0dfbbdc621d9f4b218d5a75f665cc741c100caca662dd0020b5

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