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)
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 latest/lumache.py
24 25 26 27 28 29 30 31 32 33 34 |
|
The kind
parameter should be either "meat"
, "fish"
, or "veggies"
.
Otherwise, get_random_ingredients
will raise an exception lumache.InvalidKindError
.
For example:
>>> import lumache
>>> lumache.get_random_ingredients()
['shells', 'gorgonzola', 'parsley']