Metadata-Version: 2.4
Name: loggerctl
Version: 2026.5.26.15.15
Summary: Logging tools for console and file logging
Author-email: AstroLightz <astrolightz@noreply.codeberg.org>
License-Expression: GPL-3.0-only
License-File: LICENSE
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.13
Requires-Dist: backports-zstd; python_version < '3.14'
Requires-Dist: termcolor>=3.3.0
Description-Content-Type: text/markdown

# loggerctl

`loggerctl` is a Python library for logging data to the console and files.

Full documentation can be found on ReadTheDocs(TODO)

## Features

loggerctl features multiple available Logger presets to use:

- `SimpleLogger`: A simple logger that can log to STDOUT or STDERR. Can be colored.
- `FileLogger`: A logger that can log to a file. Cannot be colored.
- `TeeLogger`: A logger that can log to both a file and STDOUT. Can be colored.

In addition, the base logger class, `Logger`, can be used to create custom presets.

Each logger can take a `log_type` parameter to set the severity level of the log:

- `INFO`: A regular info message: Yellow
- `DEBUG`: A debug message: Dark gray
- `SUCCESS`: A success message: Green
- `WARN`: A warning message: Orange/Bright yellow
- `ERROR`: An error message: Red
- `CRITICAL`: A critical message: Red text, black background

All types can be found in `LogType`. Additionally, setting `type_coloring` to `True` will
color the text the same way as the log type.

`LogDate` can be used to get the current date and time. Pass `True` to `utc` to use UTC time instead of
the local timezone.

## Installation

`loggerctl` can be installed from [PyPI](https://pypi.org/project/loggerctl/) using **pip**:

```
pip install loggerctl
```

## Quickstart

TODO

## Credits

Thank you to the following:

- **[termcolor](https://github.com/termcolor/termcolor)**: Most of the coloring is done by this package. Huge thanks to
  the devs for this amazing package!
- **[Sphinx](https://www.sphinx-doc.org)**: Used for building the documentation.
- **[ReadTheDocs](https://readthedocs.com)**: Used for hosting the documentation.

## License

    Copyright (C) 2026  AstroLightz

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
  
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.