Enums

Enumeration types used throughout the library.

EntityType

Used with the generic CRUD methods to specify which Grocy entity to operate on.

EntityType

Bases: str, Enum

PRODUCTS = 'products' class-attribute instance-attribute

CHORES = 'chores' class-attribute instance-attribute

PRODUCT_BARCODES = 'product_barcodes' class-attribute instance-attribute

BATTERIES = 'batteries' class-attribute instance-attribute

LOCATIONS = 'locations' class-attribute instance-attribute

QUANTITY_UNITS = 'quantity_units' class-attribute instance-attribute

QUANTITY_UNIT_CONVERSIONS = 'quantity_unit_conversions' class-attribute instance-attribute

SHOPPING_LIST = 'shopping_list' class-attribute instance-attribute

SHOPPING_LISTS = 'shopping_lists' class-attribute instance-attribute

SHOPPING_LOCATIONS = 'shopping_locations' class-attribute instance-attribute

RECIPES = 'recipes' class-attribute instance-attribute

RECIPES_POS = 'recipes_pos' class-attribute instance-attribute

RECIPES_NESTINGS = 'recipes_nestings' class-attribute instance-attribute

TASKS = 'tasks' class-attribute instance-attribute

TASK_CATEGORIES = 'task_categories' class-attribute instance-attribute

PRODUCT_GROUPS = 'product_groups' class-attribute instance-attribute

EQUIPMENT = 'equipment' class-attribute instance-attribute

USER_FIELDS = 'userfields' class-attribute instance-attribute

USER_ENTITIES = 'userentities' class-attribute instance-attribute

USER_OBJECTS = 'userobjects' class-attribute instance-attribute

MEAL_PLAN = 'meal_plan' class-attribute instance-attribute

MEAL_PLAN_SECTIONS = 'meal_plan_sections' class-attribute instance-attribute

TransactionType

Stock transaction types (purchase, consume, etc.).

TransactionType

Bases: Enum

PURCHASE = 'purchase' class-attribute instance-attribute

CONSUME = 'consume' class-attribute instance-attribute

INVENTORY_CORRECTION = 'inventory-correction' class-attribute instance-attribute

PRODUCT_OPENED = 'product-opened' class-attribute instance-attribute

PeriodType

Chore scheduling period types.

PeriodType

Bases: str, Enum

MANUALLY = 'manually' class-attribute instance-attribute

DYNAMIC_REGULAR = 'dynamic-regular' class-attribute instance-attribute

DAILY = 'daily' class-attribute instance-attribute

WEEKLY = 'weekly' class-attribute instance-attribute

MONTHLY = 'monthly' class-attribute instance-attribute

YEARLY = 'yearly' class-attribute instance-attribute

ADAPTIVE = 'adaptive' class-attribute instance-attribute

HOURLY = 'hourly' class-attribute instance-attribute

AssignmentType

Chore assignment strategies.

AssignmentType

Bases: str, Enum

NO_ASSIGNMENT = 'no-assignment' class-attribute instance-attribute

WHO_LEAST_DID_FIRST = 'who-least-did-first' class-attribute instance-attribute

RANDOM = 'random' class-attribute instance-attribute

IN_ALPHABETICAL_ORDER = 'in-alphabetical-order' class-attribute instance-attribute

MealPlanItemType

Types of meal plan entries.

MealPlanItemType

Bases: str, Enum

NOTE = 'note' class-attribute instance-attribute

PRODUCT = 'product' class-attribute instance-attribute

RECIPE = 'recipe' class-attribute instance-attribute