Divulge

Opinionated console messaging helper for Python — coloured, prefixed info / success / warning / error / system lines.

The PyPI name is lupaxa-divulge. The import path is lupaxa.divulge. lupaxa is a namespace package — there is no lupaxa/__init__.py. This is a library only: there is no console script and no python -m entry point.

Install

pip install lupaxa-divulge

Requires Python 3.10+. Colours come from termcolor 3.0+ (installed with the package).

Usage

import lupaxa.divulge as divulge
from datetime import datetime

divulge.info("Server starting")
divulge.success("Operation completed")
divulge.warning("Disk usage high")
divulge.error("Connection failed")
divulge.system("Starting backup job")

divulge.info({"id": 1, "status": "ok"})
divulge.info(datetime.now())

divulge.Divulge("done").success()
divulge.divulge({"id": 1}).warning()
divulge.divulge("Chained").info().success()

warning and error write to stderr. The other levels write to stdout. Empty or whitespace-only messages are skipped. Strings print as-is, datetime values use the configured time format, and other objects are pretty-printed.

Turn colours or prefixes off for the process. Only DivulgeConfig field names are applied; unknown keys are ignored:

divulge.configure(use_colours=False, use_prefixes=False)
divulge.configure(info_prefix="[ NOTE ]", system_colour="light_blue")

Bold is off by default. Enable it for one call or for the process:

divulge.info("this line is bold", use_bold=True)
divulge.configure(use_bold=True)

On Divulge, warn is an alias of warning and ok is an alias of success. Each level method returns self, so you can chain.

A walkthrough of the API is in demo.py (not shipped in the wheel):

python demo.py

Levels

system is dark_grey on purpose so those lines sit behind the other four. termcolor is called with force_color=True, so use_colours is the switch that matters — output is not gated on whether stdout looks like a TTY.

Options

Any call accepts the same knobs as configure(), plus short aliases:

Level-specific names such as info_colour still work when you pass them explicitly. Colour names must be valid termcolor names (light_cyan, dark_grey, …). Unknown names print uncoloured.

divulge.info(datetime.now(), time_format="%H:%M:%S", prefix="[ TIME ]")
divulge.success("saved", colour="light_green", prefix="[ OK ]")

configure() and per-call options use these DivulgeConfig fields:

Public names from lupaxa.divulge: __version__, get_version(), configure(), the five level functions, Divulge, divulge(), DivulgeConfig, and DEFAULT_TIME_FORMAT.

From Source

make init
make python-install-dev
make python-check