Metadata-Version: 2.5
Name: lupaxa-divulge
Version: 0.1.1
Summary: Opinionated console messaging helper with coloured, prefixed output.
Project-URL: Homepage, https://divulge.thelupaxaproject.org/
Project-URL: Documentation, https://divulge.thelupaxaproject.org/
Project-URL: Repository, https://github.com/lupaxa-developers-toolbox/divulge
Project-URL: Issues, https://github.com/lupaxa-developers-toolbox/divulge/issues
Author: The Lupaxa Project
License: MIT License
        
        Copyright (c) 2026 The Lupaxa Project
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENCE
Keywords: ansi,colour,console,messaging
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: termcolor>=3.0
Provides-Extra: dev
Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
Requires-Dist: hatch>=1.12.0; extra == 'dev'
Requires-Dist: mkdocs-material==9.7.7; extra == 'dev'
Requires-Dist: mkdocs==1.6.1; extra == 'dev'
Requires-Dist: mypy>=1.12.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest>=8.0; extra == 'test'
Description-Content-Type: text/markdown

<!-- markdownlint-disable -->
<p align="center">
  <a href="https://github.com/lupaxa-developers-toolbox">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/developers-toolbox/readme-logo.png" alt="Project Logo" width="256"/><br/>
  </a>
</p>
<h3 align="center">
  The Lupaxa Developers Toolbox<br />
  Part of The Lupaxa Project
</h3>

<br />

# 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](https://pypi.org/project/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

```bash
pip install lupaxa-divulge
```

### From source (development mode)

```bash
pip install -e ".[dev]"
```

Requires Python 3.10+. Runtime dependency: `termcolor`.

## Usage

```python
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:

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

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

```python
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](https://github.com/lupaxa-developers-toolbox/divulge).

## Development

Clone the repository and install with Make:

```bash
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/>.

<a href="https://github.com/the-lupaxa-project">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
</a>
