loe-simp-app-fw 1.9.0

A super simple python app framework that includes a logger and a config manager. Also usable in jupyter notebook.

loe-simp-app-fw

A super simple python app framework that includes a logger and a config manager. This framework is also useable in Jupyter Notebook.

Example

a typical project that uses this framework

project
├── config-example.yaml
├── config.yaml
├── LICENSE
├── log
│   └── 2024-04-16.log
├── README.md
├── src
│   └── main.py
└── tests
    └── test_import.py

Loading

import os

from loe_simp_app_fw import Config
from loe_simp_app_fw import Logger

Config("config.yaml", example_config_path="config-example.yaml", project_root_path=os.path.dirname(os.path.dirname(os.path.realpath(__file__))))
Logger("log", project_root_path=os.path.dirname(os.path.dirname(os.path.realpath(__file__))))

It will read from

[project root path]/"config.yaml"

The example config is located at

[project root path]/"config-example.yaml"

The log file will be at

[project root path]/"log"/yyyy-mm-dd.log

Basic Usage

Logger usage

Logger.debug("This is a debug message.")
Logger.info("This is a info message.")
Logger.warning("This is a warning message.")
Logger.error("This is a error message.")

Config usage

something = Config.config["project root path"]

Advance Usage

Config hot reload

Config("another-config.yaml")

.gitignore

log/
config*.yaml
!config-example.yaml