Read settings from config files
Read configuration settings from configuration files.
When developing a python
package, e.g a command-line tool, it can be
helpful to allow the user to set their own configuration options to allow them
to tailor the tool to their needs. These options are typically set in files in
the root of a project directory that uses the tool, for example in a
pyproject.toml
or an {project_name}.ini
file.
maison
aims to provide a simple and flexible way to read and validate those
configuration options so that they may be used in the package.
pip install maison
Suppose the following pyproject.toml
lives somewhere in a project directory:
[tool.acme]
enable_useful_option = true
maison
exposes a ProjectConfig
class to retrieve values from config files
like so:
from maison import ProjectConfig
from my_useful_package import run_useful_action
config = ProjectConfig(project_name="acme")
if config.get_option("enable_useful_option"):
run_useful_action()
See the documentation for more details.
MIT