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 user's 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 user's directory:
[tool.acme]
enable_useful_option = true
maison exposes a UserConfig class to retrieve values from config files
like so:
from maison import UserConfig
from my_useful_package import run_useful_action
config = UserConfig(package_name="acme")
if config.values["enable_useful_option"]:
run_useful_action()
See the documentation for more details.
MIT
FAQs
Read settings from config files
We found that maison 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.
Research
/Security News
Threat actors hijacked Toptal’s GitHub org, publishing npm packages with malicious payloads that steal tokens and attempt to wipe victim systems.
Research
/Security News
Socket researchers investigate 4 malicious npm and PyPI packages with 56,000+ downloads that install surveillance malware.
Security News
The ongoing npm phishing campaign escalates as attackers hijack the popular 'is' package, embedding malware in multiple versions.