Config

pydantic settings neophile.config.Config

Configuration for neophile.

Parameters:

• _env_file (Union[str, PathLike, List[Union[str, PathLike]], Tuple[Union[str, PathLike], ...], None], default: '<object object at 0x7ff7cd718910>') –

• _env_file_encoding (Optional[str], default: None) –

• _env_nested_delimiter (Optional[str], default: None) –

• _secrets_dir (Union[str, PathLike, None], default: None) –

• values (Any) –

Fields:

• allow_expressions (bool)

• cache_enabled (bool)

• cache_path (pathlib.Path)

• github_email (str | None)

• github_token (pydantic.types.SecretStr)

• github_user (str)

• repositories (list[neophile.config.GitHubRepository])

• work_area (pathlib.Path)

field allow_expressions: bool = False

Whether to allow version expressions in dependencies

field cache_enabled: bool = True

Whether to cache inventory information

field cache_path: Path = PosixPath('/home/runner/.cache/neophile')

Path to the cache directory

field github_email: Optional[str] = None

Email address to use for GitHub commits

field github_token: SecretStr = SecretStr('')

GitHub token for creating pull requests

Constraints:

• type = string

• writeOnly = True

• format = password

field github_user: str = ''

GitHub user for creating pull requests

field repositories: list[GitHubRepository] [Optional]

List of repositories to check

field work_area: Path [Optional]

Path to a writable working directory

classmethod from_file(path)

Initialize the configuration from a file.

Parameters:

path (Path) – Path to a configuration file in YAML format.

Returns:

The configuration.

Return type:

Config