Skip to content

Meal Plan Models

Classes for representing meal plans, meal plan sections, and recipes.

MealPlanItem

MealPlanItem

Bases: BaseModel

A single entry in the meal plan.

id instance-attribute

day = None class-attribute instance-attribute

recipe_id = None class-attribute instance-attribute

recipe_servings = None class-attribute instance-attribute

note = None class-attribute instance-attribute

recipe = None class-attribute instance-attribute

section_id = None class-attribute instance-attribute

section = None class-attribute instance-attribute

type instance-attribute

product_id = None class-attribute instance-attribute

from_response(resp) classmethod

Create from a meal plan API response.

get_details(api_client)

Fetch and populate linked recipe and section details from the API.

MealPlanSection

MealPlanSection

Bases: BaseModel

A named section within the meal plan.

id = None class-attribute instance-attribute

name = None class-attribute instance-attribute

sort_number = None class-attribute instance-attribute

row_created_timestamp = None class-attribute instance-attribute

from_response(resp) classmethod

Create from a meal plan section API response.

MealPlanItemType

MealPlanItemType

Bases: str, Enum

Type of item in a meal plan entry.

NOTE = 'note' class-attribute instance-attribute

PRODUCT = 'product' class-attribute instance-attribute

RECIPE = 'recipe' class-attribute instance-attribute

RecipeItem

RecipeItem

Bases: BaseModel

A recipe with serving information.

id = None class-attribute instance-attribute

name instance-attribute

description = None class-attribute instance-attribute

base_servings instance-attribute

desired_servings instance-attribute

picture_file_name = None class-attribute instance-attribute

from_response(resp) classmethod

Create from a recipe API response.

get_picture_url_path(width=400)

Build the API URL path for the recipe picture.

Parameters:

Name Type Description Default
width int

Desired image width in pixels.

400