loadfig¶

Features¶

loadfig is a Python package designed to load pyproject and TOML configuration files adhering to modern standards:

• Unified: Load your configuration either from .<mytool>.toml, .config/mytool.toml or pyproject.toml (section [tool.mytool]) using single line: tool_config = loadfig.config(name="<mytool>")
• Load pyproject.toml: Find and load the whole pyproject.toml using single line: pyproject = loadfig.pyproject()
• No dependencies: Python-only, no third-party dependencies.
• Do one thing well: Only load the configuration, use other libraries like python-dotenv ⧉ for bells and whistles.
• Git-aware: Automatically detects project's root using git (or other VCS), no need to specify the path to your configuration file.

Where can I use it?¶

When creating Python tools and you want to:

• give your users a standard place to configure it (pyproject.toml or .<mytool>.toml)
• make the choices readable and findable
• create tools without maintaining boilerplate

Quick start¶

Installation¶

> pip install loadfig

Usage¶

pyproject.toml loading¶

One line is all you need:

# Returns dict with all pyproject contents
pyproject = loadfig.pyproject()

# Get the name of the project
print(pyproject["project"]["name"])

Tool configuration loading¶

Assume you have the following section in your pyproject.toml file at the root of your project:

[tool.mytool]
name = "My Tool"
version = "1.0.0"

You can load the configuration for mytool using:

import loadfig

config = loadfig.config("mytool")
config["name"]  # "My Tool"
config["version"]  # "1.0.0"

That is all you will likely need to do to load your configuration for your Python project (in a modern, unified way).

See documentation ⧉ for more details about the arguments and options available.