Settings

Settings#

EODAGSettings defines the global EODAG configuration parameters. Values can be provided directly when creating the settings object or overridden with EODAG_-prefixed environment variables. See Core configuration using environment variables for detailled information on the supported environment variables.

pydantic settings eodag.config.EODAGSettings[source]#

Global EODAG configuration parameters.

Parameters:

values (Any)

Show JSON schema
{
   "title": "EODAGSettings",
   "description": "Global EODAG configuration parameters.",
   "type": "object",
   "properties": {
      "cfg_dir": {
         "description": "Base EODAG configuration directory. Created automatically if it does not exist.",
         "format": "path",
         "title": "Cfg Dir",
         "type": "string"
      },
      "cfg_file": {
         "anyOf": [
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Path to the main EODAG user configuration file. If not set, defaults to ``<cfg_dir>/eodag.yml``.",
         "title": "Cfg File"
      },
      "EODAG_LOCS_CFG_FILE": {
         "anyOf": [
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Path to the locations configuration file. If not set, defaults to ``<cfg_dir>/locations.yml``.",
         "title": "Eodag Locs Cfg File"
      },
      "collections_cfg_file": {
         "default": "/home/docs/checkouts/readthedocs.org/user_builds/eodag/envs/stable/lib/python3.14/site-packages/eodag/resources/collections.yml",
         "description": "Path to the collections configuration file. Defaults to the bundled EODAG collections definition.",
         "format": "path",
         "title": "Collections Cfg File",
         "type": "string"
      },
      "providers_cfg_file": {
         "anyOf": [
            {
               "format": "path",
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "Legacy single provider configuration file. Deprecated since ``v4.5.0``; use :attr:`providers_cfg_dir` instead.",
         "title": "Providers Cfg File"
      },
      "providers_cfg_dir": {
         "default": "/home/docs/checkouts/readthedocs.org/user_builds/eodag/envs/stable/lib/python3.14/site-packages/eodag/resources/providers",
         "description": "Directory containing provider configuration files. All ``*.yml`` files in this directory are loaded. Ignored if :attr:`providers_cfg_file` is set.",
         "format": "path",
         "title": "Providers Cfg Dir",
         "type": "string"
      },
      "EODAG_EXT_COLLECTIONS_CFG_URI": {
         "default": "https://cs-si.github.io/eodag/eodag/resources/ext_collections.json",
         "description": "URI of the external collections configuration. Supports HTTP(S), ``file://`` URIs and local filesystem paths.",
         "title": "Eodag Ext Collections Cfg Uri",
         "type": "string"
      },
      "strict_collections": {
         "default": false,
         "description": "Enable strict collection synchronization.",
         "title": "Strict Collections",
         "type": "boolean"
      },
      "providers_whitelist": {
         "description": "List of provider names to whitelist. Can be set as a comma-separated string.",
         "items": {
            "type": "string"
         },
         "title": "Providers Whitelist",
         "type": "array"
      },
      "validate_collections": {
         "default": false,
         "description": "Log collections validation errors as warning.",
         "title": "Validate Collections",
         "type": "boolean"
      }
   },
   "additionalProperties": false
}

Config:

  • env_prefix: str = EODAG_

  • validate_by_name: bool = True

Fields:
Validators:

  • warn_deprecated_settings » all fields

field cfg_dir: Path [Optional]#

Base EODAG configuration directory. Created automatically if it does not exist.

field cfg_file: Optional[Path]#

Path to the main EODAG user configuration file. If not set, defaults to <cfg_dir>/eodag.yml.

field collections_cfg_file: Path#

Path to the collections configuration file. Defaults to the bundled EODAG collections definition.

field ext_collections_cfg_uri: str#

URI of the external collections configuration. Supports HTTP(S), file:// URIs and local filesystem paths.

field locations_cfg_file: Optional[Path]#

Path to the locations configuration file. If not set, defaults to <cfg_dir>/locations.yml.

field providers_cfg_dir: Path#

Directory containing provider configuration files. All *.yml files in this directory are loaded. Ignored if providers_cfg_file is set.

field providers_cfg_file: Optional[Path]#

Legacy single provider configuration file. Deprecated since v4.5.0; use providers_cfg_dir instead.

field providers_whitelist: Annotated[list[str], NoDecode, BeforeValidator(comma_separated_str_to_list)] [Optional]#

List of provider names to whitelist. Can be set as a comma-separated string.

Constraints:

  • __module__ = pydantic_settings.sources.types

  • __firstlineno__ = 23

  • __doc__ = Annotation to prevent decoding of a field value.

  • __static_attributes__ = ()

  • __dict__ = {‘__module__’: ‘pydantic_settings.sources.types’, ‘__firstlineno__’: 23, ‘__doc__’: ‘Annotation to prevent decoding of a field value.’, ‘__static_attributes__’: (), ‘__dict__’: <attribute ‘__dict__’ of ‘NoDecode’ objects>, ‘__weakref__’: <attribute ‘__weakref__’ of ‘NoDecode’ objects>}

  • __weakref__ = <attribute ‘__weakref__’ of ‘NoDecode’ objects>

  • func = <function comma_separated_str_to_list at 0x77a7505c9170>

  • json_schema_input_type = PydanticUndefined

field strict_collections: bool#

Enable strict collection synchronization.

field validate_collections: bool#

Log collections validation errors as warning.