Metadata-Version: 2.4
Name: square_logger
Version: 3.0.0
Summary: python logger for my personal use.
Home-page: https://github.com/thepmsquare/square_logger
Author: Parth Mukesh Mangtani, Amish Palkar
Author-email: thepmsquare@gmail.com, amishpalkar302001@gmail.com
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Utilities
Classifier: Topic :: System :: Logging
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic>=2.5.3
Provides-Extra: test
Requires-Dist: pytest>=8.0.0; extra == "test"
Requires-Dist: pytest-asyncio>=1.2.0; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: license-file
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: summary

# square_logger

> 📌 versioning: see [CHANGELOG.md](./CHANGELOG.md).

## about

python logger for my personal use.

## goals

- standardized opinionated logging setup
- improved readability
- auto logging decorators
- redaction support in auto logging
- simple configuration

## installation

```shell
pip install square_logger
```

## usage

see [USAGE.md](./USAGE.md) or [example.py](./example.py).
> note:
> - SquareLogger provides a full opinionated setup with file rotation, formatters, redaction, and auto_logger decorator.
> - SquareCustomLogger wraps any existing logging.Logger and adds the auto_logger decorator plus optional redaction
    without changing your original logger.

## env

- python>=3.12.0

> feedback is appreciated. thank you!
