Skip to content

Adaendra/python-config-loader

Repository files navigation

Python Config Loader

badge

The objective of this library is to easily load external configs for a Python project and use it for anywhere in your project.


How does it work?

By default, it will load a config file called "application.yaml" stored in "/app/resources".

But you can override :

  • the name of the config file
  • the extension to JSON
  • the path to the directory with the configs files

Also you can define an environment, then 2 files will be loaded :

  • the "common" config file - application.yaml
  • the "environment" config file - application-[environment].yaml

How to use it

Install with pip

pip install adaendra-python-config-loader

Import the configs and use it!

from AdaendraConfigs import AdaendraConfigs

print(AdaendraConfigs.configs.abc)

Configuration environment variables

Name Description Default value
CONFIG_ENVIRONMENT Environment to load None
CONFIG_FOLDER Path to the config files '/app/resources'
CONFIG_FILE_EXTENSION File extensions of your config file. Allow : '.yml'/'.yaml'/'.json' '.yaml'
CONFIG_PROJECT_NAME Name of your project (which is generally the name of the config files) 'application'

Documentation

About

A config loader for your next python project

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages