Skip to main content

Project Logo

The Lupaxa Developers Toolbox
Part of The Lupaxa Project


lupaxa-divulge

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

Built for scripts and tools used by The Lupaxa Project.

Features

  • Simple functions for common message types: info, success, warning, error, and system
  • Optional colours (via termcolor) and prefixes (for example [ Info ], [ System ])
  • Optional bold via use_bold (off by default)
  • Global configuration and per-call prefix / colour overrides
  • Pretty-prints non-string values and formats datetime objects
  • Two idioms:
    • Procedural: divulge.info("message")
    • Chainable: Divulge("message").info()
  • Fully typed, linted, formatted, and tested

Installation

From PyPI

pip install lupaxa-divulge

From source (development mode)

pip install -e ".[dev]"

Requires Python 3.10+. Runtime dependency: termcolor.

Usage

import lupaxa.divulge as divulge

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

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

Turn colours or prefixes off for the process:

divulge.configure(use_colours=False, use_prefixes=False)

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)

A walkthrough of the API is in demo.py in the source repository.

Development

Clone the repository and install with Make:

make init                # first-time makefile-skills checkout
make python-install-dev  # editable install with [dev]
make python-check        # lint, type-check, and test
make mkdocs-serve        # local docs site

Documentation: https://divulge.thelupaxaproject.org/.

The Lupaxa Project Footer

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

lupaxa_divulge-0.1.2.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

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

lupaxa_divulge-0.1.2-py3-none-any.whl (7.3 kB view details)

Uploaded Python 3

File details

Details for the file lupaxa_divulge-0.1.2.tar.gz.

File metadata

  • Download URL: lupaxa_divulge-0.1.2.tar.gz
  • Upload date:
  • Size: 6.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for lupaxa_divulge-0.1.2.tar.gz
Algorithm Hash digest
SHA256 6de19c8028da2503ee26da7ca998c234ba48c2776caee546530f6cfa7a57a73c
MD5 516ac9f12dfa91101d4069a4fdc78caa
BLAKE2b-256 6f99ddb6aea1c17d7a35a5931d49df14c568432d10bf8829393318ed60eafb62

See more details on using hashes here.

Provenance

The following attestation bundles were made for lupaxa_divulge-0.1.2.tar.gz:

Publisher: generate-release.yml on lupaxa-developers-toolbox/divulge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file lupaxa_divulge-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: lupaxa_divulge-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for lupaxa_divulge-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 cc702a56d00f3bc4c161f031605e987fb413be482d50ca20c3571671f0e3338e
MD5 4522958005027d68c86b932806b223b4
BLAKE2b-256 423b4833a1f36b47e2f82546e64e9291c61ba844cbd0d87b8b2962ac3d931450

See more details on using hashes here.

Provenance

The following attestation bundles were made for lupaxa_divulge-0.1.2-py3-none-any.whl:

Publisher: generate-release.yml on lupaxa-developers-toolbox/divulge

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.2 This release

2 files

0.1.1

2 files

0.1.0

2 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