Metadata-Version: 2.1
Name: exzlogger
Version: 0.0.1
Summary: Easily create useful logger.
Project-URL: Homepage, https://github.com/TongRao/exzlogger
Project-URL: Issues, https://github.com/TongRao/exzlogger/issues
Author-email: TongRao <tongrao121@gmail.com>
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.5
Description-Content-Type: text/markdown

# Exzlogger 
##### *Extremely Easy Logger*

---
This package is made to easily create logger that is suit for most of the situations, including following functions:

- automatically create "log" folder under the work directory
- the log information will be displayed on stdout, and will also be stored in the .log file
- allow user to set the information level for both stdout and log file
- nicely formatted log information, including the timestamp and information type

## Parameters
- `stdout_level` \<str\>: The log level to be used for stdout ('INFO', 'ERROR', 'DEBUG', or 'WARNING'), Defaults to 'INFO'.
- `file_level` \<str\>: The log level to be used for the log file ('INFO', 'ERROR', 'DEBUG', or 'WARNING'), Defaults to 'DEBUG'.
- `log_file` \<str\>: The path and name of the log file to write the log messages, defaults to 'logfile.log'.

## Returns
- `logger` \<logging.Logger\>: The initialized logger instance.

## Dependencies
- pathlib
- logging
- sys

## Useage
```python
# Imports
from exzlogger import initialize_logger

logger = initialize_logger(stdout_level='INFO', file_level='DEBUG', log_file='logfile.log')

# Error & Debug (suggest to import traceback for debug)
logger.error(f"[func_name]: error message<{e}>")
logger.debug(f"[func_name]: error message<{e}>\n**********\n{traceback.format_exc()}**********")

# Info
logger.info(f"[func_name]: message")

# Warning
logger.warning(f"[func_name]: warning message")
```

