jobflow_remote.config.settings module#

pydantic settings jobflow_remote.config.settings.JobflowRemoteSettings[source]#

Bases: BaseSettings

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Show JSON schema

{
   "title": "JobflowRemoteSettings",
   "type": "object",
   "properties": {
      "config_file": {
         "default": "/home/runner/.jfremote.yaml",
         "description": "Location of the config file for jobflow remote.",
         "title": "Config File",
         "type": "string"
      },
      "projects_folder": {
         "default": "/home/runner/.jfremote",
         "description": "Location of the projects files.",
         "title": "Projects Folder",
         "type": "string"
      },
      "project": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "description": "The name of the project used.",
         "title": "Project"
      },
      "cli_full_exc": {
         "default": false,
         "description": "If True prints the full stack trace of the exception when raised in the CLI.",
         "title": "Cli Full Exc",
         "type": "boolean"
      },
      "cli_suggestions": {
         "default": true,
         "description": "If True prints some suggestions in the CLI commands.",
         "title": "Cli Suggestions",
         "type": "boolean"
      },
      "cli_log_level": {
         "$ref": "#/$defs/LogLevel",
         "default": "warn",
         "description": "The level set for logging in the CLI"
      }
   },
   "$defs": {
      "LogLevel": {
         "description": "Enumeration of logging level.",
         "enum": [
            "error",
            "warn",
            "info",
            "debug"
         ],
         "title": "LogLevel",
         "type": "string"
      }
   },
   "additionalProperties": false
}