You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
34 lines
667 B
34 lines
667 B
Usage |
|
===== |
|
|
|
.. _installation: |
|
|
|
Installation |
|
------------ |
|
|
|
To use Lumache, first install it using pip: |
|
|
|
.. code-block:: console |
|
|
|
(.venv) $ pip install lumache |
|
|
|
Creating recipes |
|
---------------- |
|
|
|
To retrieve a list of random ingredients, |
|
you can use the ``lumache.get_random_ingredients()`` function: |
|
|
|
.. autofunction:: lumache.get_random_ingredients |
|
|
|
The ``kind`` parameter should be either ``"meat"``, ``"fish"``, |
|
or ``"veggies"``. Otherwise, :py:func:`lumache.get_random_ingredients` |
|
will raise an exception. |
|
|
|
.. autoexception:: lumache.InvalidKindError |
|
|
|
For example: |
|
|
|
>>> import lumache |
|
>>> lumache.get_random_ingredients() |
|
['shells', 'gorgonzola', 'parsley'] |
|
|
|
|