boilercore_tools.environment
#
Contributor environment.
Module Contents#
Classes#
Get environment variables from |
Functions#
Initialize shell. |
|
Build docs. |
|
Get virtual environment activator. |
|
Escape a path, suitable for passing to e.g. |
API#
- boilercore_tools.environment.init_shell(
- path: pathlib.Path | None = None,
Initialize shell.
- boilercore_tools.environment.run(
- args: str | collections.abc.Sequence[str],
Build docs.
- class boilercore_tools.environment.Environment(
- _case_sensitive: bool | None = None,
- _nested_model_default_partial_update: bool | None = None,
- _env_prefix: str | None = None,
- _env_file: pydantic_settings.sources.DotenvType | None = ENV_FILE_SENTINEL,
- _env_file_encoding: str | None = None,
- _env_ignore_empty: bool | None = None,
- _env_nested_delimiter: str | None = None,
- _env_parse_none_str: str | None = None,
- _env_parse_enums: bool | None = None,
- _cli_prog_name: str | None = None,
- _cli_parse_args: bool | list[str] | tuple[str, ...] | None = None,
- _cli_settings_source: pydantic_settings.sources.CliSettingsSource[Any] | None = None,
- _cli_parse_none_str: str | None = None,
- _cli_hide_none_type: bool | None = None,
- _cli_avoid_json: bool | None = None,
- _cli_enforce_required: bool | None = None,
- _cli_use_class_docs_for_groups: bool | None = None,
- _cli_exit_on_error: bool | None = None,
- _cli_prefix: str | None = None,
- _cli_implicit_flags: bool | None = None,
- _secrets_dir: pydantic_settings.sources.PathType | None = None,
- **values: Any,
Bases:
pydantic_settings.BaseSettings
Get environment variables from
pyproject.toml:[tool.boilercore_env]
.Initialization
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 allowself
as a field name.- model_config#
‘SettingsConfigDict(…)’
- classmethod settings_customise_sources(
- settings_cls,
- **_,
Customize so that all keys are loaded despite not being model fields.
- boilercore_tools.environment.get_venv_activator()#
Get virtual environment activator.
- boilercore_tools.environment.escape(
- path: str | pathlib.Path,
Escape a path, suitable for passing to e.g.
run()
.