Usage

Installation

To use Lumache, first install it using pip:

(.venv) $ pip install lumache

Creating recipes

To retrieve a list of random ingredients, you can use the lumache.get_random_ingredients() function:

lumache.get_random_ingredients(kind=None, bad=None, sus=None)

Return a list of random ingredients as strings.

Parameters:

• kind (list[str] or None) – Optional “kind” of ingredients.

• bad (list[pd.DataFrame] or None) – Optional “bad” ingredients.

• sus (list[int] or None) – Optional “sus” ingredients.

Raises:

lumache.InvalidKindError – If the kind is invalid.

Returns:

The ingredients list.

Return type:

list[str]

The kind parameter should be either "meat", "fish", or "veggies". Otherwise, lumache.get_random_ingredients() will raise an exception.

exception lumache.InvalidKindError

Raised if the kind is invalid.

For example:

>>> import lumache
>>> lumache.get_random_ingredients()
['shells', 'gorgonzola', 'parsley']

Testing new google docstring

lumache.func(arg1: int, arg2: str) → bool

Summary line.

Extended description of function.

Parameters:

• arg1 (int) – Description of arg1

• arg2 (str) – Description of arg2

Returns:

Description of return value

Return type:

bool