Chore Manager¶
Manage household chores — list, execute, undo, and assign.
Access via grocy.chores.
for chore in grocy.chores.list(get_details=True):
print(f"{chore.name} - next: {chore.next_estimated_execution_time}")
grocy.chores.execute(chore_id=1, done_by=1)
Class Reference¶
ChoreManager(api_client)
¶
Manage household chores and their execution tracking.
Access via grocy.chores.
list(get_details=False, query_filters=None)
¶
Get all chores.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
get_details
|
bool
|
Fetch full chore details for each item. |
False
|
query_filters
|
list[str] | None
|
Optional Grocy API query filters. |
None
|
get(chore_id)
¶
Get a single chore by ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chore_id
|
int
|
The Grocy chore ID. |
required |
execute(chore_id, done_by=None, tracked_time=None, skipped=False)
¶
Mark a chore as executed.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chore_id
|
int
|
The Grocy chore ID. |
required |
done_by
|
int | None
|
User ID of who performed the chore. |
None
|
tracked_time
|
datetime | None
|
When the chore was done. Defaults to now. |
None
|
skipped
|
bool
|
Mark as skipped rather than done. |
False
|
undo(execution_id)
¶
Undo a chore execution.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
execution_id
|
int
|
The chore execution ID to undo. |
required |
merge(chore_id_keep, chore_id_remove)
¶
Merge two chores, keeping one and removing the other.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chore_id_keep
|
int
|
ID of the chore to keep. |
required |
chore_id_remove
|
int
|
ID of the chore to remove. |
required |
calculate_next_assignments()
¶
Recalculate chore assignments for all chores.