https://github.com/mpcodewriter21/log21
A simple logging package that helps you log colorized messages in the Windows console.
https://github.com/mpcodewriter21/log21
codewriter21 color colorizing log log21 logging python python3
Last synced: about 2 months ago
JSON representation
A simple logging package that helps you log colorized messages in the Windows console.
- Host: GitHub
- URL: https://github.com/mpcodewriter21/log21
- Owner: MPCodeWriter21
- License: apache-2.0
- Created: 2021-09-05T14:27:34.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-12-07T14:43:38.000Z (over 1 year ago)
- Last Synced: 2025-04-13T09:19:03.057Z (about 1 year ago)
- Topics: codewriter21, color, colorizing, log, log21, logging, python, python3
- Language: Python
- Homepage:
- Size: 1.14 MB
- Stars: 11
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
log21
=====
[](https://www.codefactor.io/repository/github/mpcodewriter21/log21)
A simple logging package that helps you log colorized messages in Windows console and
other operating systems.
Features
--------
+ Colors : The main reason for this package was to log text in the Windows console with
the support of ANSI colors.
+ Argument parsing : log21's argument parser can be used like python's argparse, but it
also colorizes the output.
+ Logging : A similar logger to logging. Logger but with colorized output and other
options such as levelname modifications. It can also decolorize the output if you want
to log into a file.
+ Pretty printing : Have you ever wanted to colorize the output of the pprint module?
log21's pretty printer can do that.
+ Tree printing : You can pass a dict or list to `log21.tree_print` function, and it
will print it in a tree-like structure. It's also colorized XD.
+ ProgressBar : log21's progress bar can be used to show progress of a process in a
beautiful way.
+ LoggingWindow : Helps you to log messages and debug your code in a window other than
the console.
+ CrashReporter : log21's crash reporter can be used to report crashes in different
ways. You can use it to log crashes to console or files or use it to receive crash
reports of your program through email. And you can also define your own crash
reporter functions and use them instead!
+ Argumentify : You can use the argumentify feature to decrease the number of lines you
need to write to parse command-line arguments. It's colored by the way!
+ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues)
or submit a pull request.
Installation
------------
Well, this is a python package so the first thing you need is python.
If you don't have python installed, please visit [Python.org](https://python.org) and
install the latest version of python.
Then you can install log21 using pip module:
```bash
python -m pip install log21 -U
```
Or you can clone [the repository](https://github.com/MPCodeWriter21/log21) and run:
```bash
pip install .
```
Or let the pip get it using git:
```bash
pip install git+https://github.com/MPCodeWriter21/log21
```
Changelog
---------
### v3.3.0
Add `log21.helper_types` module.
This module contains a collection of useful types meant for using with argument parser
to parse CLI arguments to more usable formats.
+ `FileSize`: Can take `str` and `int` values. Will convert human inputs such as "121 KB",
"21MiB", or "4.56 GB" to bytes. Can also be used to represent bytes value in more
human-readable formats.
For even more control you can still define Logger, Handlers, and Formatters manually.
#### Example
```python
from pathlib import Path
import log21
from log21.helper_types import FileSize
def main(path: Path, min_size: FileSize, max_size: FileSize, /):
log21.info(
"Files that are smaller than %s or bigger than %s will be ignored.",
args=(min_size, max_size),
)
for file in path.iterdir():
if not file.is_file():
continue
if min_size <= (size := file.stat().st_size) <= max_size:
log21.print(
"`%s` is %s.",
args=(file, FileSize(size).humanize(binary=False, fmt="%.4f")),
)
if __name__ == "__main__":
log21.argumentify(main)
```
Example usage and output:
```shell
$ uv run test.py . "1.23MiB" "0.5 GB"
[21:21:21] [INFO] Files that are smaller than 1.23 MiB or bigger than 476.84 MiB will be
ignored.
`myfile21.zip` is 35.1856 MB.
```
[Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)
Usage Examples
---------------
See [EXAMPLES.md](https://github.com/MPCodeWriter21/log21/blob/master/EXAMPLES.md)
About
-----
Author: CodeWriter21 (Mehrad Pooryoussof)
GitHub: [MPCodeWriter21](https://github.com/MPCodeWriter21)
Telegram Channel: [@CodeWriter21](https://t.me/CodeWriter21)
### License
[apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)
### Donate
In order to support this project you can donate some crypto of your choice 8D
[Donate Addresses](https://github.com/MPCodeWriter21/log21/blob/master/DONATE.md)
Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a star on
GitHub :)
References
----------
+ ANSI Color Codes (Wikipedia):
[https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)