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_manual(kind=None)#

MANUAL DEFINITION Return a list of random ingredients as strings.

Parameters:

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

Raises:

lumache.InvalidKindError – If the kind is invalid.

Returns:

The ingredients list.

Return type:

list[str]

lumache.get_random_ingredients(kind=None)[source]#

Return a list of random ingredients as strings.

A more complexe multiline description of the function itself.

Parameters:

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

Raises:

lumache.InvalidKindError – If the kind is invalid.

Returns:

The ingredients list.

Return type:

list[str]

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

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

exception lumache.InvalidKindError[source]#

Raised if the kind is invalid.

exception lumache.InvalidKindErrorMANUAL#

MANUAL DEFINITION Raised if the kind is invalid.

typedef std::vector<int> CustomList#

A typedef-like declaration of a type.

Cross reference to CustomList.

class lumache.MyClass(likes_spam: bool = False)[source]#

Summary of class here.

Longer class information… Longer class information…

likes_spam#

A boolean indicating if we like SPAM or not.

Type:

bool

eggs#

An integer count of the eggs we have laid.

Type:

int

public_method()[source]#

Performs operation blah.

class lumache.MyClass2(likes_spam: bool = False)[source]#

Bases: MyClass

Summary of class2 here.

Longer class information… Longer class information…

public_method()#

Performs operation blah.

public_method2()[source]#

Performs operation 2 blah.

class lumache.MyClass3(ref)[source]#

Summary of class3 here.

Longer class information… Longer class information…

ref#

A refernce to MyClass

Type:

MyClass

class lumache.MyClass4(ref: MyClass)[source]#

Summary of class4 here.

Longer class information… Longer class information…

ref#

A refernce to MyClass

class lumache.MyClass5(ref: MyClass4)[source]#

Summary of class5 here.

Longer class information… Longer class information…

ref#

A refernce to MyClass4

Todo

Fix this