Skip to main content

Convenience of configuration and logging.

Project description

Yirgachefe

A library for the convenience of configuring environment variables, configuration files, and logger.

Prerequisite

  • Python 3.7.9

Quick start

The configuration file format is JSON, and the default location is [CWD]/configure.json.

  • CWD: Current working directory (you can get it with 'os.getcwd()')

Example configure.json

{
  "API_PORT": 8100,
  "STORAGE_ID": "storage_1"
}

Example Code

from yirgachefe import config, logger

logger.debug(config['API_PORT'])
logger.info(config.API_PORT)

config['NEW'] = 'new value'
config.NEW2 = 'new value2'

Custom Usage

Default configure.json.

  • This value is set internally and is used even if the file doesn't exist.
  • You can use the changed value by explicitly setting it in the file.
{
  "debug": false,
  "log_level": "WARNING",
  "log_format": "%(asctime)s,%(msecs)03d %(process)d %(thread)d %(levelname)s %(filename)s(%(lineno)d) %(message)s",
  "log_path": "project-sample.log"
}
  • debug: Set stream handler to logging with coloredlog.
  • log_level: Log level for logging.
  • log_format: Log format for logging.
  • log_path: Write a file log if present (optional)

Optional configuration for RotatingFileHandler.

  • yirgachefe supports time-based log file rotating.
  • Each option is as follows.
  • Rotating works when all values are present.
{
  "log_when": "d",
  "log_interval": 1,
  "log_backup_count": 10
}
  • log_when: rotating unit s | m | h | d | w0-w6 (see. 'logging.handler')
  • log_interval: rotating period
  • log_backup_count: log backup count.

Make and Save configure.json

  • After creating an empty config class, you can set the config value and save it as a file.
from yirgachefe import Config

config = Config()
config.NEW = 'new value'
config.write_config()

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

yirgachefe-0.1.4.tar.gz (9.5 kB view hashes)

Uploaded Source

Built Distribution

yirgachefe-0.1.4-py3-none-any.whl (11.6 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page