Skip to content

Commit

Permalink
Update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
MPCodeWriter21 committed Dec 7, 2024
1 parent d2f264c commit a4a39d9
Show file tree
Hide file tree
Showing 4 changed files with 33 additions and 22 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ Help this project by [Donation](DONATE.md)
Changes
-------

### 2.10.2

+ Update README.md and CHANGELOG.md.

### 2.10.1

+ Updated the Argparse module to be usable with python 3.12.3.
Expand Down
47 changes: 27 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,39 +7,46 @@ log21
![repo size](https://img.shields.io/github/repo-size/MPCodeWriter21/log21)
[![CodeFactor](https://www.codefactor.io/repository/github/mpcodewriter21/log21/badge)](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.
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.
+ 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.
+ Any idea? Feel free to [open an issue](https://github.com/MPCodeWriter21/log21/issues)
or submit a pull request.

![issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
![Issues](https://img.shields.io/github/issues/MPCodeWriter21/log21)
![contributors](https://img.shields.io/github/contributors/MPCodeWriter21/log21)

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.
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:

Expand All @@ -54,6 +61,7 @@ pip install .
```

Or let the pip get it using git:

```bash
pip install git+https://github.com/MPCodeWriter21/log21
```
Expand All @@ -67,15 +75,14 @@ Changes

[Full CHANGELOG](https://github.com/MPCodeWriter21/log21/blob/master/CHANGELOG.md)


Usage Examples:
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)
Expand All @@ -99,5 +106,5 @@ Or if you can't, give [this project](https://github.com/MPCodeWriter21/log21) a
References
----------

+ ANSI Color Codes (
Wikipedia): [https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)
+ ANSI Color Codes (Wikipedia):
[https://en.wikipedia.org/wiki/ANSI_escape_code](https://en.wikipedia.org/wiki/ANSI_escape_code#Colors)
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ dependencies = [
"webcolors",
"docstring-parser"
]
version = "2.10.1"
version = "2.10.2"

[tool.setuptools.packages.find]
where = ["src"]
Expand Down
2 changes: 1 addition & 1 deletion src/log21/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
from .StreamHandler import StreamHandler, ColorizingStreamHandler

__author__ = 'CodeWriter21 (Mehrad Pooryoussof)'
__version__ = '2.10.1'
__version__ = '2.10.2'
__github__ = 'Https://GitHub.com/MPCodeWriter21/log21'
__all__ = [
'ColorizingStreamHandler', 'DecolorizingFileHandler', 'ColorizingFormatter',
Expand Down

0 comments on commit a4a39d9

Please sign in to comment.