Skip to main content

A tool for generating customizable ASCII art messages with speech bubbles and cow-style templates, supporting styled text using AnsiMarkup.

Project description

ccowsay

screenshot

🐮 A tool for generating customizable ASCII art messages with speech bubbles and cow-style templates, supporting styled text using AnsiMarkup.

Features

  • Custom .ccow templates define ASCII art structure.
  • Styled text formatting (colors, bold, italic, underline) via AnsiMarkup.
  • Text alignment (left, center, right), word wrapping, and whitespace replacement.
  • Dynamic template variables (eyes, tongue, etc.) that can be overridden.
  • Simple configuration directory for templates and defaults.

Installation

pipx install ccowsay

Basic Usage

ccowsay "Hello World!"

For full details of supported tags and syntax see the AnsiMarkup documentation.

Command-Line Options

Option Description Default
-f, --ccow-format Path or alias to a .ccow template @/cow.ccow
-a, --text-align Text alignment: left, center, right left
-w, --wrap-width Max width before wrapping (use -1 to disable wrapping) 40
--replace-whitespace Replace tabs/newlines with spaces False
-c, --corners Four characters for bubble corners (TL, TR, BL, BR) / \ / \
-s, --sides Four characters for bubble sides (top, bottom, left, right) | - | -
-v, --values JSON string of template variable overrides {}
-l, --list-formats List available .ccow templates
--get Download a .ccow template from a GitHub repository and save it to the user config directory

Custom Templates

Templates live in your config directory (e.g., ~/.config/ccowsay/). Each .ccow file has two parts: JSON metadata, then ASCII art, separated by ---. Example:

{
  "eyes": "oo",
  "tongue": "  "
}
---
{message}
        {backslash}   ^__^
         {backslash}  ({eyes})\_______
            (__)\       )\/\
             {tongue} ||----w |
                ||     ||

Override variables with --values, for example:

ccowsay -f "@/cow.ccow" -v '{"eyes": "xx", "tongue": "U "}' "I'm tired..."

Coloring with XML-Style Tags

You can use XML-style tags from ansimarkup to add colors, bold, or italic text inside your .ccow templates.

[!WARNING] Do not use these tags directly in messages passed to ccowsay — they are intended for ASCII art templates only.

Example inside a .ccow file:

{
  "eyes": "oo",
  "tongue": "  "
}
---
<red>{message}</red>
        {backslash}   ^__^
         {backslash}  (<green>{eyes}</green>)\_______
            (__)\       )\/\
             {tongue} ||----w |
                ||     ||

This ensures that all colors and styles are applied safely when rendering the ASCII art.

Using Templates from the Config Directory

Any .ccow file placed in your user config directory (usually ~/.config/ccowsay/) can be referenced using the @/ prefix.

For example:

ccowsay -f "@/cow.ccow" "Hello World!"
  • @/cow refers to cow.ccow inside your config directory.
  • This works for any custom template you add there.
  • The default configuration also uses this syntax to load the built-in cow.

Downloading Templates

Use --get flag to download and store .ccow files locally:

ccowsay --get user/repo/path/to/file.ccow

Embedding in Python

from ccowsay import ccowsay, TextAlign

ascii_art = ccowsay(
    "<green>Hello from code!</green>",
    open("cow.ccow").read(),
    text_align=TextAlign.CENTER,
    wrap_width=40,
    eyes="oO",
    tongue="U "
)
print(ascii_art)

License

MIT License — free to use, modify, and distribute.

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

ccowsay-1.1.2.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

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

ccowsay-1.1.2-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file ccowsay-1.1.2.tar.gz.

File metadata

  • Download URL: ccowsay-1.1.2.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.9

File hashes

Hashes for ccowsay-1.1.2.tar.gz
Algorithm Hash digest
SHA256 e0223b2f4d28915a28a2e19367ff7b8c250f6504f612a49db7908aae80032953
MD5 6958a0002f359dd9e7ba6dd14214a41e
BLAKE2b-256 40eeabb53b25d94cfb61041db54712037e44bf36b7db6236466a2bbb6627b9ea

See more details on using hashes here.

File details

Details for the file ccowsay-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: ccowsay-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.9

File hashes

Hashes for ccowsay-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cdc607b2cf9c5a6e27ed4f9a0f78e881d31124321b8e41967184eeda514025d4
MD5 ce88a6e55074193eb0b8a6b01d089e05
BLAKE2b-256 66557afbc1c06d3229f079a4b6bfc4b9d672c8e01d152b091a8a575d8f83cf14

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