Metadata-Version: 2.4
Name: readylog
Version: 0.5.0
Summary: Creates a reasonable logging configuration for a Python project
Keywords: logging,logging configuration
Author: fleetingbytes
Author-email: fleetingbytes <7075397+fleetingbytes@users.noreply.github.com>
License-Expression: BSD-2-Clause
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Requires-Python: >=3.11
Project-URL: Homepage, http://github.com/fleetingbytes/readylog
Project-URL: Documentation, http://github.com/fleetingbytes/readylog/blob/master/README.md
Project-URL: Repository, http://github.com/fleetingbytes/readylog.git
Project-URL: Issues, http://github.com/fleetingbytes/readylog/issues
Project-URL: Changelog, http://github.com/fleetingbytes/readylog/blob/master/CHANGELOG.md
Description-Content-Type: text/markdown

# readylog
Readylog is a logging configuration template for Python's logging.

## Usage

Basic example:

```python
# my_app.py

from logging.config import dictConfig as configure_logging
from logging import getLogger
from pathlib import Path

from platformdirs import user_log_dir
from readylog import create_dict_config


def setup_logging() -> None:
    app_name = "my_app"
    author = "Me"

    log_dir = Path(user_log_dir(app_name, author))
    log_dir.mkdir(parents=True, exist_ok=True)

    logging_config = create_dict_config(log_dir / "debug.log", app_name)
    configure_logging(logging_config)


logger = getLogger(__name__)
setup_logging()

logger.debug("This should be logged")
```

## Documentation

```python
from readylog import create_dict_confg

print create_dict_config.__doc__
```
