compose.add_readable_time

compose.add_readable_time(dt, format_str='%B %d, %Y')

Format a datetime as readable text.

Parameters

dt : datetime

Datetime object to format.

format_str : str = '%B %d, %Y'

Python strftime format string. Default is “%B %d, %Y” (e.g., “November 10, 2025”).

Returns

: str

Formatted date/time string.

Raises

: TypeError

If dt is not a datetime object.

Examples

from datetime import datetime
from nbmail.compose import add_readable_time, block_text, compose_email

time_str = add_readable_time(datetime.now())

compose_email(
    body=block_text(f"Report generated: {time_str}")
)

Report generated: November 14, 2025