app.config

Module Contents

Classes

RegexHeuristics	Regex heuristics options for applying modifying a line using regex lines.
ConverterOptions	Converter options.
Configurator	Configurator class for the app.

Functions

yaml_config_settings_source(settings)	Custom settings source that reads the settings from a YAML file.
ensure_config_exists()	Ensure config file exist at the path specified in the environment variable CONFIG_PATH.

app.config.yaml_config_settings_source(settings: pydantic.BaseSettings)

Custom settings source that reads the settings from a YAML file.

app.config.ensure_config_exists()

Ensure config file exist at the path specified in the environment variable CONFIG_PATH.

class app.config.RegexHeuristics

Bases: pydantic.BaseModel

Regex heuristics options for applying modifying a line using regex lines.

True means option is enabled, False means option is disabled.

remove_pre_tag: bool = True

class app.config.ConverterOptions

Bases: pydantic.BaseModel

Converter options.

Attributes

author_rewritestr

Will rewrite the author to this value for all the posts.

links_rewritelist[dict]

Will rewrite the links to this value for all the posts.

header_fields_droplist[str]

Will drop the specified header fields from the posts.

author_rewrite: str = ''

links_rewrite: list[dict] = []

header_fields_drop: list[str] = []

enable_regex_heuristics: bool = True

regex_heuristics: RegexHeuristics

class app.config.Configurator

Bases: pydantic.BaseSettings

Configurator class for the app.

Attributes

logging_level: str

The logging level.

source_pathstr

The path to the Jekyll posts.

output_pathstr

The path to the Hugo posts.

converterstr

The converter that converts the markdown

class Config

env_file_encoding = 'utf-8'

classmethod customise_sources(init_settings, env_settings, file_secret_settings)

logging_level: str = 'INFO'

source_path: str

output_path: str

converter: str

converter_options: ConverterOptions