Logger

config.logging.py

import logging.config
import os
from pathlib import Path
import yaml

def configure_logging(log_config_path, log_directory):
  with open(log_config_path, 'r') as f:
    config = yaml.safe_load(f)
    config['handlers']['file']['filename'] = str(log_directory / config['handlers']['file']['filename'])
    logging.config.dictConfig(config)

project_root = Path(__file__).resolve().parent.parent
logs_directory = project_root / 'logs'
logs_directory.mkdir(exist_ok=True)

logging_config_path = project_root / 'config' / 'logging.yaml'
configure_logging(logging_config_path, logs_directory)

logger = logging.getLogger("package_name")

logger.info("Logging started")

config.logging.yml

version: 1

formatters:
  simple:
    format: '%(asctime)s - %(name)s - %(levelname)s - %(message)s'

  handlers:
    console:
      class: logging.StreamHandler
      level: INFO
      formatter: simple
    file:
      class: logging.FileHandler
      level: INFO
      formater: simple
      filename: package_name.log

  loggers:
    root:
      level: INFO
      handlers: [console, file]
    package_name:
      level: INFO
      handlers: [console, file]

  root:
    level: INFO
    handlers: [console, file]

We can then use it by:

import logging
logger = logging.getLogger(__name__)

This will place the package_name.log logfile under projectroot/logs directory.