A super simple python app framework that includes a logger and a config manager. This framework is also useable in Jupyter Notebook.
In addition to those function, it has a CSV IO object, a Caching object to help with common data tasks.
To get started,
python3 -m loe_simp_app_fw init-repoIt will generate a project structure,
project directory
├── .gitignore
├── .cache
│ └── (Hashed file name)
├── config-framework.yaml
├── config-project.yaml
├── LICENSE
├── log
│ └── 2024-04-16.log
├── README.md
└── src
├── configuration.py
└── main.py
In configuration.py, after the initialization, it would be,
import os
from typing import ClassVar
from loe_simp_app_fw import BaseConfig, FrameworkConfig, Logger, NotInitialized, CacheManager
#---------------------------------------------------------------
# Modify the framework config location if necessary
FrameworkConfig.load(os.path.abspath("./config-framework.yaml"))
class ProjectConfig(BaseConfig):
# Add tunable here
example_tunable: ClassVar[str] = "ExAmPlE"
#---------------------------------------------------------------
if FrameworkConfig.developer_mode:
# Skip loading the config
'''
Developer mode force the usage of the default configuration of ProjectConfig,
i.e., the one above, rather than the one in config-project.yaml
'''
Logger.warning(f"Project config is now in developer mode, settings from config-project.yaml will be ignored")
else:
# Load the config
try:
ProjectConfig.load(FrameworkConfig.project_config_path)
except NotInitialized:
Logger.warning(f"Cannot find project config file at {FrameworkConfig.project_config_path}.")
ProjectConfig.dump_example(FrameworkConfig.project_config_path)
Logger.info(f"Successfully create example project config at {FrameworkConfig.project_config_path}")
# Combine two config
class Config(ProjectConfig, FrameworkConfig):
pass
# Init logger
Logger.bootstrap(Config.log_directory, log_level = Config.log_level, buffering = Config.log_buffer_size)
# Init Cache Manager
CacheManager.setup(Config.cache_directory, Config.cache_time_to_live)
Logger.info("Configuration finish initialization")One may add additional tunables under ProjectConfig as a class variable.
In main.py, after the initialization, it would be
from loe_simp_app_fw import Logger
from configuration import Configfrom loe_simp_app_fw import Logger
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.")from configuration import Config
something = Config.log_levelfrom loe_simp_app_fw import isNotebook
# Return True when in a jupyter notebook environment.gitignore file will be generated for the project.
In addition to the python gitignore template from GitHub, the following are also added.
# Loe's Simple App Framework
playground*
database*
config*.yaml
raw
middleware
.cache*
perf/
temp