Skip to main content

caligrama

Dale una imagen y un poema. Te devuelve el poema con la forma de la imagen.

PyPI Python 3.9+ CI Licencia MIT Hecho en Rust

Un corazón que late, escrito con un poema que corre por dentro. Generado con caligrama.

El título y este corazón los genera la propia librería con caligrama animar. Código en examples/latido.py.

Un caligrama es un poema cuyas letras dibujan aquello de lo que habla. Apollinaire los hacía a mano. Esta librería los hace con cualquier imagen que le pases: detecta la silueta, la reduce a una rejilla de caracteres y escribe tu texto dentro, letra por letra y en orden. Lo que sale es texto plano, así que puedes pegarlo en un chat, en un README, en un commit o en una tarjeta.

$ caligrama logo.jpeg -w auto --sin-repetir -f becquer.txt

         Podrá nubla
        rse el sol et
       ernamente; podr
        á secarse en u
  n instante el mar; podrá r
 omperse el eje de la  tierr
a como un débil crist al. ¡To
do sucede rá! Podrá la muerte
 cubrir me con su fúnebre cre
 spón;  pero jamás en mí pod
  rá ap agarse la llama de
        tu amor.

Instalación

pip install caligrama

Eso es todo. No arrastra dependencias de Python (ni Pillow, ni numpy): la lectura de la imagen y el dibujo se hacen en Rust, dentro de una sola wheel que sirve para Python 3.9 en adelante en Linux, macOS y Windows. Funciona sin conexión y no manda nada a ningún lado.

En diez segundos

Desde Python:

import caligrama

print(caligrama.dibujar("gato.png", "Te quiero más que a mi café de la mañana", ancho=50))

Desde la terminal:

caligrama gato.png -w 50 -t "Te quiero más que a mi café de la mañana"
caligrama gato.png -f poema.txt          # el texto desde un archivo
cat poema.txt | caligrama gato.png       # o desde stdin

La imagen puede ser una ruta, un pathlib.Path o los bytes crudos (lo que te devuelve requests, una base de datos o un upload). Lee PNG, JPEG, GIF, BMP y WebP.

Diseña el texto antes de escribirlo

Lo más frustrante de hacer caligramas a mano es escribir el poema y descubrir que no cabe, o que sobra media figura. caligrama analizar te dice de antemano cuánto espacio tienes:

$ caligrama analizar logo.jpeg -w 40 -t "Podrá nublarse el sol eternamente"

Silueta a 40 columnas × 16 filas
Caben 452 letras (los espacios cuentan) ≈ 75 palabras
Tramos: 26 (de 5 a 28 letras); cada hueco entre tramos puede partir una palabra

Plantilla (letras por fila a la derecha):
               #############               │  13
             #################             │  17
            ###################            │  19
     ########################## ######     │  32
    ########################### #######    │  34
  ...

Otros anchos:
  ancho  filas  letras  ≈palabras
     30     12     252        42
     40     16     452        75
     60     23     955       159
  ...

Tu texto: 33 letras. Cabe completo desde 11 columnas (-w auto). A 40 columnas sobran 419 letras.

La plantilla coincide celda por celda con el dibujo final (hay un test que lo garantiza), así que puedes contar letras por fila y ajustar tus versos a mano. Desde Python, caligrama.analizar() devuelve lo mismo en un diccionario.

Y si no quieres contar nada, ancho="auto" busca el ancho exacto en el que tu texto llena la figura una sola vez.

Animaciones, en la terminal o en SVG

El título de este README sale de un solo comando:

caligrama animar assets/titulo.png -t caligrama -w 160 --espacios sin --con-huecos \
    --colores "#ff2d55,#ff8a3d,#b44dff" --svg titulo.svg

Sin --svg, la animación se reproduce en la terminal hasta que pulses Ctrl+C. Hay dos movimientos, y se pueden combinar:

  • --paso N: el texto avanza N letras por fotograma y parece correr por dentro de la figura. Por defecto, animar calcula cuántos fotogramas hacen falta para que el texto dé la vuelta completa, así que el bucle no tiene salto.
  • --latido F: la figura late con un pulso doble y se encoge hasta el F·100 % de su tamaño entre latidos.

Desde Python son tres funciones que encajan entre sí:

fotos = caligrama.animar("corazon.png", poema, paso=3, latido=0.22, ancho=56)   # list[str]
caligrama.reproducir(fotos, intervalo=0.07, colores=["#ff5f8f", "#ff2d55"])        # en la terminal
svg = caligrama.a_svg(fotos, intervalo=0.07, fondo="#14111a")                       # para tu README o tu web

Los fotogramas son texto normal, todos del mismo tamaño y alineados, así que también puedes llevarlos a un GIF, a una web o a donde quieras. Los colores de la terminal usan ANSI de 24 bits: funcionan en Windows Terminal, iTerm2, GNOME Terminal y en casi cualquier terminal moderna.

Los colores de la imagen

Con color=True (o --colores imagen) cada letra se pinta con el color que tiene la imagen en ese punto: la copa de un árbol sale verde y el tronco café, sin decirle dónde está cada parte. El color de cada celda es el promedio de sus píxeles de figura, así que los bordes suaves del fondo no lo ensucian.

print(caligrama.dibujar("arbol.png", poema, ancho=70, espacios="sin", color=True))
svg = caligrama.a_svg(caligrama.animar("arbol.png", poema, color=True), fondo="#111")
caligrama arbol.png -f poema.txt -w 70 --colores imagen
caligrama animar arbol.png -f poema.txt --colores imagen --svg arbol.svg

El resultado sigue siendo un str, con los colores en ANSI; a_svg y reproducir los respetan tal cual. Si además pasas un degradado con colores=, el degradado manda.

Por qué se ve bien con imágenes reales

Casi todas las herramientas de arte ASCII deciden qué es figura mirando el brillo: lo oscuro se pinta y lo claro se deja vacío. Eso falla más de lo que parece. En el logo de Python, la serpiente amarilla es casi tan clara como el fondo blanco y desaparece. En un pingüino, la barriga blanca queda como un agujero.

caligrama hace otra cosa:

  1. Estima el color del fondo con los píxeles del borde de la imagen y marca como figura lo que se aleja de ese color, con un umbral automático que se ajusta al ruido del JPEG.
  2. Rellena lo que está encerrado por la figura aunque sea del color del fondo. La barriga del pingüino vuelve a ser pingüino. Si quieres conservar los huecos (el ojo del logo, el centro de una dona), usa huecos=True.
  3. Si la imagen tiene transparencia, usa el canal alfa y listo.
  4. suavizar=N une trazos punteados o hechos de letras antes de muestrear, útil para logos de línea fina o imágenes que ya son arte ASCII.
  5. Corrige la proporción de la terminal (un carácter es el doble de alto que de ancho) para que un círculo salga redondo.
  6. Recorre el texto por grafemas, no por bytes: tildes, ñ, ü y emojis compuestos no se parten.

Todas las opciones

Python Terminal Por defecto Qué hace
ancho -w, --ancho 60 Columnas de salida. "auto" elige el menor ancho donde cabe todo el texto.
repetir --sin-repetir True Repite el texto hasta llenar la figura.
espacios --espacios "normal" normal junta espacios y separa repeticiones con uno; sin los quita todos (figura más sólida); todos los deja tal cual.
huecos --con-huecos False Respeta los huecos interiores del color del fondo.
suavizar --suavizar 0 Radio en píxeles para cerrar trazos punteados.
invertir --invertir False Escribe alrededor de la figura en vez de dentro.
umbral --umbral auto Umbral 0–255 de separación figura/fondo, por si el automático no te convence.
aspecto --aspecto 2.0 Alto/ancho de un carácter en tu terminal o fuente.
desfase --desfase 0 Empieza a escribir el texto N letras más adelante.
color --colores imagen False Pinta cada letra con el color de la imagen en su posición (ANSI de 24 bits).
colores --colores sin color Degradado horizontal en hexadecimal, en la terminal y en el SVG.
(a_svg) --svg Guarda un SVG en vez de imprimir (animado con animar).

Solo para animar: fotogramas/--fotogramas, paso/--paso, latido/--latido, intervalo/--intervalo y, en la terminal, veces/--veces.

caligrama --help muestra lo mismo.

Ideas para usarlo

  • Una tarjeta de cumpleaños que es su foto escrita con los mensajes de todos.
  • El banner de bienvenida de tu CLI con tu logo y el nombre de la herramienta.
  • Un mensaje para alguien especial, con la forma de algo que solo ustedes entienden.
  • Una pantalla de carga para tu CLI con tu logo latiendo mientras el texto corre por dentro.

Para verlo en acción:

python examples/demo.py          # recorrido por la API
bash examples/demo.sh            # recorrido por la terminal
python examples/latido.py        # el corazón latiendo en tu terminal
python examples/titulo.py        # el título de este README, animado en tu terminal

Cómo está hecho

El núcleo (src/core.rs) es Rust puro: decodifica la imagen con el crate image, construye la máscara, la muestrea a una rejilla de caracteres y rellena. Las animaciones, el SVG y los colores viven en src/animacion.rs, también en Rust. Encima hay una capa fina de PyO3 (src/lib.rs) que expone dibujar, analizar, animar, a_svg, reproducir y el comando caligrama, y maturin lo empaqueta como wheel abi3. El CLI también es Rust, así que se comporta igual que la API.

Contribuir

Los issues y PRs son bienvenidos. Para montar el entorno:

git clone https://github.com/maosuarez/caligrama && cd caligrama
python -m venv .venv && source .venv/bin/activate
pip install maturin pytest
maturin develop
cargo test && pytest

Los detalles están en CONTRIBUTING.md.

Licencia

MIT. Úsalo en lo que quieras, también en proyectos comerciales.


In English

caligrama turns any image into a calligram: it finds the silhouette and writes your text inside it, in reading order, returning plain text you can paste anywhere.

pip install caligrama
caligrama cat.png -w 50 -t "your poem here"
import caligrama
print(caligrama.dibujar("cat.png", "your poem here", ancho="auto"))
info = caligrama.analizar("cat.png", "your poem here")   # capacity, per-row counts, template
frames = caligrama.animar("heart.png", "your poem ", paso=2, latido=0.2)
caligrama.reproducir(frames)                               # animate in the terminal
open("heart.svg", "w").write(caligrama.a_svg(frames))       # or export an animated SVG

The core is written in Rust (PyO3 + maturin) and ships as a single abi3 wheel with zero Python dependencies. Instead of a brightness threshold it detects the background from the image border and fills enclosed regions, so light-on-white subjects keep their shape. The API and CLI flags are in Spanish; the table above maps every option.

Release files for caligrama 0.3.0

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

Source distribution (sdist)

Source distribution for caligrama 0.3.0
File Size Uploaded
caligrama-0.3.0.tar.gz 52.5 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for caligrama 0.3.0
File
caligrama-0.3.0-cp39-abi3-win_amd64.whl CPython 3.9 abi3 Windows x86-64 Details
caligrama-0.3.0-cp39-abi3-musllinux_1_2_x86_64.whl CPython 3.9 abi3 Linux musl 1.2+ x86-64 Details
caligrama-0.3.0-cp39-abi3-musllinux_1_2_aarch64.whl CPython 3.9 abi3 Linux musl 1.2+ ARM64 Details
caligrama-0.3.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl CPython 3.9 abi3 Linux glibc 2.17+ x86-64 Details
caligrama-0.3.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl CPython 3.9 abi3 Linux glibc 2.17+ ARM64 Details
caligrama-0.3.0-cp39-abi3-macosx_11_0_arm64.whl CPython 3.9 abi3 macOS 11.0+ ARM64 Details
caligrama-0.3.0-cp39-abi3-macosx_10_12_x86_64.whl CPython 3.9 abi3 macOS 10.12+ x86-64 Details

Total release size: 5.6 MB

Release files / caligrama-0.3.0.tar.gz

Download URL caligrama-0.3.0.tar.gz
Size 52.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b7cec72be70da943cb7b3d15a14338b605d71ef687e75ea64f1a17d915ceff56
BLAKE2b-256 checksum
How to use checksums
5069e4884feacc63d1ef0591ea1019d706f59b9c69b89dcc7f4f81d08d50dd2a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release files / caligrama-0.3.0-cp39-abi3-win_amd64.whl

Download URL caligrama-0.3.0-cp39-abi3-win_amd64.whl
Size 701.3 kB
Tags CPython 3.9 Windows x86-64 abi3
SHA-256 checksum
How to use checksums
0642ff30fc83a23c424c565a2fd8ebec270f5f7fbf5bb2efa44bd82f031e0860
BLAKE2b-256 checksum
How to use checksums
d0b1bb4217b07c7f8fa97ef57909a3f34a7fbeb8de07942aa70479d9f36c9ba5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release files / caligrama-0.3.0-cp39-abi3-musllinux_1_2_x86_64.whl

Download URL caligrama-0.3.0-cp39-abi3-musllinux_1_2_x86_64.whl
Size 979.3 kB
Tags CPython 3.9 Linux musl 1.2+ x86-64 abi3
SHA-256 checksum
How to use checksums
a74dbe316b668cbe6fe56124b5382f4309d9de1de4cec34cb12ad9378e1b8c8f
BLAKE2b-256 checksum
How to use checksums
3d3220ae5381b865771a514ae912e5424b773af7ee2857d3e99942cd640a4e3e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release files / caligrama-0.3.0-cp39-abi3-musllinux_1_2_aarch64.whl

Download URL caligrama-0.3.0-cp39-abi3-musllinux_1_2_aarch64.whl
Size 908.7 kB
Tags CPython 3.9 Linux musl 1.2+ ARM64 abi3
SHA-256 checksum
How to use checksums
ba354b944d67a43772ecac8f3d766ecc482814891de1831b5ba580ecebfaeb38
BLAKE2b-256 checksum
How to use checksums
7602052e9e042ec99d3eec0f7e91fe3f025a0d1b23359f3a6adf17c220b94a95
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release files / caligrama-0.3.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl

Download URL caligrama-0.3.0-cp39-abi3-manylinux_2_17_x86_64.manylinux2014_x86_64.whl
Size 767.2 kB
Tags CPython 3.9 Linux glibc 2.17+ x86-64 abi3
SHA-256 checksum
How to use checksums
0846b9b622a447a6eb87c507a925cce3950b94b7754ba1df15ce459a23f4757a
BLAKE2b-256 checksum
How to use checksums
a409dc83fcf4830878dc9247a6e0fd9cdab804fbbac32d82237b2231db507864
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release files / caligrama-0.3.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl

Download URL caligrama-0.3.0-cp39-abi3-manylinux_2_17_aarch64.manylinux2014_aarch64.whl
Size 730.3 kB
Tags CPython 3.9 Linux glibc 2.17+ ARM64 abi3
SHA-256 checksum
How to use checksums
0dc86587795f2dd9dfefa2c277dcb7923c08cb852ed55523adbcb50a4eb4e605
BLAKE2b-256 checksum
How to use checksums
f9ec337a25a7303101a1a73556df67148c8ebe6a7c203f57161f1522f33d6a1b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release files / caligrama-0.3.0-cp39-abi3-macosx_11_0_arm64.whl

Download URL caligrama-0.3.0-cp39-abi3-macosx_11_0_arm64.whl
Size 708.3 kB
Tags CPython 3.9 abi3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
fff87a22489138c25fd41fbb15b2aa76503ea6e3394e78ad4b355452dd47b62d
BLAKE2b-256 checksum
How to use checksums
eec794ca0a15a34fd538d99e0f75f8c0ba28daefa71e94d6ac1756285dce3cd1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release files / caligrama-0.3.0-cp39-abi3-macosx_10_12_x86_64.whl

Download URL caligrama-0.3.0-cp39-abi3-macosx_10_12_x86_64.whl
Size 738.1 kB
Tags CPython 3.9 abi3 macOS 10.12+ x86-64
SHA-256 checksum
How to use checksums
ca7d2e47fd855ef9f7d49a47ead5cf9d55263aec0684f4459e4761a4dc154d12
BLAKE2b-256 checksum
How to use checksums
9bcdf7eb6d5002e0f860f96438a50b07f42ac6497939db7dfa3acc73c1da2510
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 25, 2026.

Transparency log

Release history Release notifications | RSS feed

0.3.2

8 release files

0.3.1

8 release files

This release

0.3.0 This release

8 release files

0.2.0

8 release files

0.1.0

8 release files

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