Metadata-Version: 2.1
Name: shadowlogger
Version: 0.1.1
Home-page: https://github.com/Capsize-Games/shadowlogger
Author: Capsize LLC
Author-email: contact@capsizegames.com
License: GPL-3.0
Requires-Python: >=3.10.0
Description-Content-Type: text/markdown
License-File: LICENSE

# Shadowlogger

Simple wrapper for built-in logger module which intercepts all logs and shadows them, preventing sensitive information from being leaked.

---

![img.png](img.png)

[![Upload Python Package](https://github.com/Capsize-Games/shadowlogger/actions/workflows/python-publish.yml/badge.svg)](https://github.com/Capsize-Games/shadowlogger/actions/workflows/python-publish.yml)

---

## Installation

```bash
pip install shadowlogger
```

---

## Usage

```python
import shadowlogger

# Activate shadowlogger
shadowlogger.manager.install()

# Deactivate shadowlogger
shadowlogger.manager.uninstall()
```

or 

```python
from shadowlogger.shadowlogger import ShadowLogger


class MyCustomLogger(ShadowLogger):
    # override these to customize the logger
    prefix: str
    name: str
    message_format: str
    log_level: int
    
    # override this to handle the formatted message
    def handle_message(self, formatted_message: str, level_name: str):
        pass
```

---

## Testing

```bash
python -m unittest discover -s tests
```
