API Reference

Lumache - Python library for cooks and food lovers.

This is a Python docstring, we can use Markdown syntax here because our API documentation library understands it (mkdocstrings).

# Import lumache
import lumache

# Call its only function
get_random_ingredients(kind=["cheeses"])

`InvalidKindError`

Bases: Exception

Raised if the kind is invalid.

Source code in repo/lumache.py

class InvalidKindError(Exception):
    """Raised if the kind is invalid."""

    pass

`get_random_ingredients(kind=None)`

Return a list of random ingredients as strings.

Parameters:

Name	Type	Description	Default
`kind`	`list[str] \| None`	Optional "kind" of ingredients.	`None`

Returns:

Type	Description
`list[str]`	The ingredients list.

Raises:

Type	Description
`lumache.InvalidKindError`	If the kind is invalid.

Source code in repo/lumache.py

def get_random_ingredients(kind=None):
    """
    Return a list of random ingredients as strings.

    :param kind: Optional "kind" of ingredients.
    :type kind: list[str] or None
    :raise lumache.InvalidKindError: If the kind is invalid.
    :return: The ingredients list.
    :rtype: list[str]
    """
    return ["shells", "gorgonzola", "parsley"]