A library for loading configurations (or other metadata) hierarchically based on the current environment
| Source | Downloads | Page | Installation Command |
|---|---|---|---|
| PyPi | Link | pip install hierarchical-conf |
| Develop | Stable | Documentation | Sonar |
|---|---|---|---|
 |  |
This library supports Python version 3.7+.
To check library main features you can check Hierarchical Conf's Documentation, which is hosted by Read the Docs.
An example of how to use the library getting configurations:
from hierarchical_conf.hierarchical_conf import HierarchicalConf
hierarchical_conf = HierarchicalConf(searched_paths=[PROJECT_ROOT])
my_config = hierarchical_conf.get_config("my_config_key")
This tool retrieve the configurations from (YAML) files according to the current environment and files precedence.
It receives a list of paths and searches each one for environment configuration files in an orderly
fashion, loading them when found and overwriting duplicated configuration keys by the value of the key
available in the file loaded at last.
The YAML configuration files are expected to be named with prefixes based on the working environment,
retrieved by the value of a pre-existent operational system environment's variable named ENVIRONMENT.
E.g.: Given the respective environments dev and production configuration files below:
dev_conf.yml:
foo: bar_dev
foo2: bar_dev2
production_conf.yml:
foo: bar_prod
foo2: bar_prod2
and given we are at development environment (ENVIRONMENT=dev), the following code will load the
configuration file from the development environment file (/my_path/dev_conf.yml).
hconf = HierarchicalConf(conf_files_paths=['/my_path/'])
foo_conf = hconf.get_config("foo")
print(foo_conf)
# prints: bar_dev
Given ENVIRONMENT=production, the code above will load the configuration file from
the production environment file (/my_path/production_conf.yml) and print: bar_prod.
To learn more use cases in practice (and about the keys overwriting), see Hierarchical Conf examples
The Hierarchical Conf depends on Python 3.7+
Python Package Index hosts reference to a pip-installable module of this library, using it is as straightforward as including it on your project's requirements.
pip install hierarchical-conf
All contributions are welcome! Feel free to open Pull Requests. Check the development and contributing guidelines described in CONTRIBUTING.md
Made with :heart: by the Data Engineering team from QuintoAndar
FAQs
A tool for loading settings from files hierarchically
We found that hierarchical-conf demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.