Skip to main content

A tool for converting images into character-based art

Project description

img-characterize

A powerful Python tool for converting images into artistic character-based representations, supporting multiple character sets and output formats.

Features

  • Multiple Character Sets: Support for ASCII, Arabic, Braille, Emoji, Chinese, Roman, Latin, Hiragana, Katakana, Kanji, Cyrillic, and Hangul
  • Color Support: Option to preserve original image colors
  • Multiple Output Formats: PNG, JPG, and TXT output formats
  • Parallel Processing: Efficient processing of multiple images
  • Large Image Support: Automatic division of large images
  • Customizable: Adjustable character resolution and complexity levels

Installation

pip install img-characterize

Quick Start

Basic usage:

characterize -i image.jpg -cr 1000 -cl 12 -f png txt

With color preservation:

characterize -i image.jpg -cr 1000 -cl 12 -f png -c

Process multiple images:

characterize -i image1.jpg image2.png -cr 1000 -cl 12 -f png txt

Command Line Arguments

Argument Description Values
-i, --i Input file paths One or more image paths
-cr, --cr Character resolution 1 to 4000
-cl, --cl Complexity level 1 to 40
-l, --l Character set ascii, arabic, braille, emoji, chinese, simple, numbers+, roman, numbers, latin, hiragana, katakana, kanji, cyrillic, hangul
-d, --d Divide large images true/false
-c, --c Preserve colors true/false
-f, --f Output formats png, jpg, txt
-ec, --ec Include empty character true/false
-o, --o Optimize output files true/false
-tk, --tk Use GUI file selection true/false
-v, --v Enable verbose logging true/false

Examples

  1. Create ASCII art with color:
characterize -i photo.jpg -l ascii -c true -f png
  1. Generate Kanji art in black and white:
characterize -i artwork.png -l kanji -cr 2000 -cl 20 -f png txt
  1. Process multiple images with emoji characters:
characterize -i pic1.jpg pic2.jpg -l emoji -cr 1500 -cl 15 -f png

Output

The program creates output files in your specified format(s):

  • PNG/JPG: Character-based image representation
  • TXT: Plain text representation using the selected characters

Output files are saved in the output directory with the same base name as the input file.

Performance Tips

  1. For large images:

    • Use the -d flag to enable automatic image division
    • Lower the character resolution (-cr) for faster processing
  2. For batch processing:

    • The program automatically uses parallel processing
    • Consider using lower complexity levels for faster results

Requirements

  • Python 3.8 or higher
  • Required packages are automatically installed with pip

Contributing

Contributions are welcome! Feel free to submit issues and pull requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Author

Augusto Rehfeldt

Acknowledgments

Thanks to all contributors and users who help improve this tool.

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

img_characterize-0.2.0.tar.gz (70.6 kB view details)

Uploaded Source

Built Distribution

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

img_characterize-0.2.0-py3-none-any.whl (14.4 kB view details)

Uploaded Python 3

File details

Details for the file img_characterize-0.2.0.tar.gz.

File metadata

  • Download URL: img_characterize-0.2.0.tar.gz
  • Upload date:
  • Size: 70.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for img_characterize-0.2.0.tar.gz
Algorithm Hash digest
SHA256 255f1776b2020c0221bb79697dc1276ab927c5a78bbfd80369e9f9c4b24fa8fd
MD5 ca5a49cc0028f8fe5bbe9c840677447f
BLAKE2b-256 0db586ab6dd05caeddfed446752d42244649b7e327d56b173a2428e5af3b9d9a

See more details on using hashes here.

File details

Details for the file img_characterize-0.2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for img_characterize-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6e694e4e4eea28e4e8d2bdde2f1f8fdc9a16aea902ceb86d76ea807877062947
MD5 2c75eeaa332b52df88710df4db2bd13d
BLAKE2b-256 b2d222cd5e99cfc766dd35638c1b68192b6e2dd0feb50addac8fcd4d688d1c3c

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