all2md.cli.presets

Configuration presets for all2md CLI.

This module defines preset configurations for common use cases like fast processing, high quality output, minimal text extraction, etc.

all2md.cli.presets.get_preset_names() → list[str]

Get list of available preset names.

Returns:

List of preset names

Return type:

list[str]

Examples

>>> names = get_preset_names()
>>> print(names)
['fast', 'quality', 'minimal', 'complete', 'archival', 'documentation']

all2md.cli.presets.get_preset_config(preset_name: str) → Dict[str, Any]

Get configuration dictionary for a preset.

Parameters:

preset_name (str) – Name of the preset

Returns:

Configuration dictionary for the preset

Return type:

dict

Raises:

ValueError – If preset name is not recognized

Examples

>>> config = get_preset_config("fast")
>>> print(config['attachment_mode'])
skip

all2md.cli.presets.get_preset_description(preset_name: str) → str

Get description for a preset.

Parameters:

preset_name (str) – Name of the preset

Returns:

Description of the preset

Return type:

str

Raises:

ValueError – If preset name is not recognized

Examples

>>> desc = get_preset_description("fast")
>>> print(desc)
Fast processing optimized for speed over quality

all2md.cli.presets.apply_preset(preset_name: str, base_config: Dict[str, Any]) → Dict[str, Any]

Apply a preset to a base configuration.

Merges preset configuration into base config, with base config taking precedence for any conflicting keys. This allows CLI arguments and explicit config files to override preset values.

Parameters:

• preset_name (str) – Name of the preset to apply

• base_config (dict) – Base configuration to merge preset into

Returns:

Merged configuration with preset applied

Return type:

dict

Raises:

ValueError – If preset name is not recognized

Examples

>>> base = {'attachment_mode': 'save'}
>>> result = apply_preset('fast', base)
>>> # attachment_mode remains 'save' (base takes precedence)
>>> print(result['attachment_mode'])
save
>>> # But pdf.skip_image_extraction comes from preset
>>> print(result['pdf']['skip_image_extraction'])
True

all2md.cli.presets.list_presets() → list[tuple[str, str]]

Get list of all presets with descriptions.

Returns:

List of (name, description) tuples for all presets

Return type:

list[tuple[str, str]]

Examples

>>> presets = list_presets()
>>> for name, desc in presets:
...     print(f"{name}: {desc}")
fast: Fast processing optimized for speed over quality
quality: High quality processing with maximum fidelity
...