Skip to content

Documentation

Welcome to 🪵 DearLog's documentation!

Getting Started

Simply import it and start logging:

from dearlog import logger  # isort: split

logger.info("Hello, DearLog!")
logger.note("• Colored by default")
logger.todo("• Plan your work")

logger.ok("✔ Quickstart complete!")

Always import dearlog first

First thing it does is getting a time.monotonic() instant for stopwatch accuracy.

  • The isort statement ensures formatters don't move it below other imports.

Oh, and rich formatting is enabled by default

logger.minor((
    "[bold red]Consider "
    "[link=https://github.com/sponsors/Tremeschin/]Supporting[/link][/] "
    "me on GitHub!"
))