Reference

sopsy

SOPSy, a Python wrapper around SOPS.

SOPS binary must be installed and available in your $PATH.

Sops

Sops(
    file: str | Path,
    *,
    config: str | Path | None = None,
    config_dict: dict[str, Any] | None = None,
    extract: str | None = None,
    in_place: bool = False,
    input_type: str | SopsyInOutType | None = None,
    output: str | Path | None = None,
    output_type: str | SopsyInOutType | None = None
)

SOPS file object.

Attributes:

Name	Type	Description
`file`	`Path`	Path to the SOPS file.
`global_args`	`list[str]`	The list of arguments that will be passed to the `sops` shell command. It can be used to customize it. Use it only if you know what you are doing.

Examples:

>>> from pathlib import Path
>>> from sopsy import Sops
>>> sops = Sops(Path("secrets.json"), config=Path(".config/sops.yml"))

Parameters:

Name	Type	Description	Default
`file`	`str \| Path`	Path to the SOPS file.	required
`config`	`str \| Path \| None`	Path to a custom SOPS config file.	`None`
`config_dict`	`dict[str, Any] \| None`	Allow to pass SOPS config as a python dict.	`None`
`extract`	`str \| None`	Extract a specific key or branch from the input document.	`None`
`in_place`	`bool`	Write output back to the same file instead of stdout.	`False`
`input_type`	`str \| SopsyInOutType \| None`	If not set, sops will use the file's extension to determine the type.	`None`
`output`	`str \| Path \| None`	Save the output after encryption or decryption to the file specified.	`None`
`output_type`	`str \| SopsyInOutType \| None`	If not set, sops will use the input file's extension to determine the output format.	`None`

Source code in src/sopsy/sopsy.py

def __init__(
    self,
    file: str | Path,
    *,
    config: str | Path | None = None,
    config_dict: dict[str, Any] | None = None,
    extract: str | None = None,
    in_place: bool = False,
    input_type: str | SopsyInOutType | None = None,
    output: str | Path | None = None,
    output_type: str | SopsyInOutType | None = None,
) -> None:
    """Initialize SOPS object.

    Examples:
        >>> from pathlib import Path
        >>> from sopsy import Sops
        >>> sops = Sops(Path("secrets.json"), config=Path(".config/sops.yml"))

    Args:
        file: Path to the SOPS file.
        config: Path to a custom SOPS config file.
        config_dict: Allow to pass SOPS config as a python dict.
        extract: Extract a specific key or branch from the input document.
        in_place: Write output back to the same file instead of stdout.
        input_type: If not set, sops will use the file's extension to determine
            the type.
        output: Save the output after encryption or decryption to the file
            specified.
        output_type: If not set, sops will use the input file's extension to
            determine the output format.
    """
    self.file: Path = Path(file).resolve(strict=True)
    self.global_args: list[str] = []
    if extract:
        self.global_args.extend(["--extract", extract])
    if in_place:
        self.global_args.extend(["--in-place"])
    if input_type:
        self.global_args.extend(["--input-type", str(input_type)])
    if output:
        self.global_args.extend(["--output", str(output)])
    if output_type:
        self.global_args.extend(["--output-type", str(output_type)])

    if isinstance(config, str):
        config = Path(config)
    if config_dict is None:
        config_dict = {}
    config_dict = build_config(config_path=config, config_dict=config_dict)
    with tempfile.NamedTemporaryFile(mode="w", delete=False) as fp:
        yaml.dump(config_dict, fp)
        config_tmp = fp.name
    self.global_args.extend(["--config", config_tmp])

    if not shutil.which("sops"):
        msg = (
            "sops command not found, "
            "you may need to install it and/or add it to your PATH"
        )
        raise SopsyCommandNotFoundError(msg)

decrypt

decrypt(*, to_dict: bool = True) -> bytes | dict[str, Any] | None

Decrypt SOPS file.

Examples:

>>> from sopsy import Sops, SopsyInOutType
>>> sops = Sops("secrets.json", output_type=SopsyInOutType.YAML)
>>> sops.decrypt(to_dict=False)
hello: world

Parameters:

Name	Type	Description	Default
`to_dict`	`bool`	Return the output as a Python dict.	`True`

Returns:

Type	Description
`bytes \| dict[str, Any] \| None`	The output of the sops command.

Source code in src/sopsy/sopsy.py

def decrypt(self, *, to_dict: bool = True) -> bytes | dict[str, Any] | None:
    """Decrypt SOPS file.

    Examples:
        >>> from sopsy import Sops, SopsyInOutType
        >>> sops = Sops("secrets.json", output_type=SopsyInOutType.YAML)
        >>> sops.decrypt(to_dict=False)
        hello: world

    Args:
        to_dict: Return the output as a Python dict.

    Returns:
        The output of the sops command.
    """
    cmd = ["sops", "--decrypt", *self.global_args, str(self.file)]
    return run_cmd(cmd, to_dict=to_dict)

encrypt

encrypt(*, to_dict: bool = True) -> bytes | dict[str, Any] | None

Encrypt SOPS file.

Examples:

>>> import json
>>> from pathlib import Path
>>> from sopsy import Sops
>>> secrets = Path("secrets.json")
>>> secrets.write_text(json.dumps({"hello": "world"}))
>>> sops = Sops(secrets, in_place=True)
>>> sops.encrypt()

Parameters:

Name	Type	Description	Default
`to_dict`	`bool`	Return the output as a Python dict.	`True`

Returns:

Type	Description
`bytes \| dict[str, Any] \| None`	The output of the sops command.

Source code in src/sopsy/sopsy.py

def encrypt(self, *, to_dict: bool = True) -> bytes | dict[str, Any] | None:
    """Encrypt SOPS file.

    Examples:
        >>> import json
        >>> from pathlib import Path
        >>> from sopsy import Sops
        >>> secrets = Path("secrets.json")
        >>> secrets.write_text(json.dumps({"hello": "world"}))
        >>> sops = Sops(secrets, in_place=True)
        >>> sops.encrypt()

    Args:
        to_dict: Return the output as a Python dict.

    Returns:
        The output of the sops command.
    """
    cmd = ["sops", "--encrypt", *self.global_args, str(self.file)]
    return run_cmd(cmd, to_dict=to_dict)

get

get(key: str, *, default: Any = None) -> Any

Get a specific key from a SOPS encrypted file.

Examples:

>>> from sopsy import Sops
>>> sops = Sops("secrets.json")
>>> sops.get("hello")
b'world'
>>> sops.get("nonexistent", default="DefaultValue")
'DefaultValue'

Parameters:

Name	Type	Description	Default
`key`	`str`	The key to fetch in the SOPS file content.	required
`default`	`Any`	A default value in case the key does not exist or is empty.	`None`

Returns:

Type	Description
`Any`	The value of the given key, or the default value.

Source code in src/sopsy/sopsy.py

def get(self, key: str, *, default: Any = None) -> Any:  # noqa: ANN401
    """Get a specific key from a SOPS encrypted file.

    Examples:
        >>> from sopsy import Sops
        >>> sops = Sops("secrets.json")
        >>> sops.get("hello")
        b'world'
        >>> sops.get("nonexistent", default="DefaultValue")
        'DefaultValue'

    Args:
        key: The key to fetch in the SOPS file content.
        default: A default value in case the key does not exist or is empty.

    Returns:
        The value of the given key, or the default value.
    """
    data: dict[Any, Any] = self.decrypt()  # pyright: ignore[reportAssignmentType]
    return data.get(key) or default

rotate

rotate(*, to_dict: bool = True) -> bytes | dict[str, Any] | None

Rotate encryption keys and re-encrypt values from SOPS file.

Examples:

>>> from sopsy import Sops
>>> sops = Sops("secrets.json", in_place=True)
>>> sops.rotate()

Parameters:

Name	Type	Description	Default
`to_dict`	`bool`	Return the output as a Python dict.	`True`

Returns:

Type	Description
`bytes \| dict[str, Any] \| None`	The output of the sops command.

Source code in src/sopsy/sopsy.py

def rotate(self, *, to_dict: bool = True) -> bytes | dict[str, Any] | None:
    """Rotate encryption keys and re-encrypt values from SOPS file.

    Examples:
        >>> from sopsy import Sops
        >>> sops = Sops("secrets.json", in_place=True)
        >>> sops.rotate()

    Args:
        to_dict: Return the output as a Python dict.

    Returns:
        The output of the sops command.
    """
    cmd = ["sops", "--rotate", *self.global_args, str(self.file)]
    return run_cmd(cmd, to_dict=to_dict)