Home Keeper

[![Integration Usage][usage-shield]][usage] [![GitHub Downloads][downloads-shield]][releases] [![GitHub Release][release-shield]][releases] [![GitHub Release Date][release-date-shield]][releases] [![GitHub Activity][commits-shield]][commits] [![License][license-shield]](LICENSE) [![hacs][hacs-shield]][hacs] ![Project Maintenance][maintenance-shield] [![ko-fi][kofi-shield]][kofi] [![HACS Validation][hacs-validation-shield]][hacs-validation] [![HA Version][ha-version-shield]][ha-version] [![Docs][docs-shield]][docs]

Home Keeper tracks home maintenance and chores in Home Assistant. This includes fridge and furnace filter changes, water filters, taking medicine, and anything else that recurs.

📖 Full documentation (a browsable User Guide and Developer Guide) lives at

. The site is generated from

docs/, so the two never drift.

!Home Keeper task list

What people say

It's exceptionally well thought out, fills a real gap in the Home Assistant

ecosystem, and has great potential to become the go-to maintenance tracker for

many users.

> @psym88

So happy to finally see such a thorough solution to this problem. I hope this

really takes off and becomes a core component of HA.

> @peng1can

It is currently much closer to the maintenance tracker I had been looking for

than anything else I tried.

> @Tomblarom

Features at a glance

• Tasks support 5 recurrence types. These are floating, fixed, one-off, triggered,

• Home Keeper provides native Home Assistant entities. A todo list and an

• Home Keeper syncs the tasks of a profile to any todo entity as they become

• The bundled dashboard card custom:home-keeper-card has a Done button and

• Every notes field on a task or appliance or part or completion is Markdown

• A task can link to a Home Assistant tag so that a scan completes it. The task

• An appliance has a device page with structured metadata and optional

• Home Keeper fires a bus event for every state change and provides device

• Every data action is a home_keeper.* service for automations and scripts and

• Home Keeper is localized in 16 languages and follows the Home Assistant

• Other integrations can contribute their own recurring tasks and stay in sync

Installation

Home Keeper is a custom integration installed with HACS:

1. In HACS, add this repository as a custom repository, category

1. Install Home Keeper and restart Home Assistant.
2. Add the integration from **Settings → Devices & Services → Add Integration →

A Home Keeper panel then appears in the sidebar. Tasks and appliances are stored locally in a single JSON document, .storage/home_keeper.

Documentation

• User Guide: every

• Developer Guide:

• Release notes.

Development

• Backend: custom_components/home_keeper/. The recurrence engine is in

• Panel frontend: custom_components/home_keeper/frontend/, built with

• Tests: pytest unit tests in tests/unit, Docker integration tests in

• Typing: mypy custom_components/home_keeper, configured in pyproject.toml

See AGENTS.md for workflow and RELEASE.md for releases.

[usage-shield]: https://img.shields.io/badge/dynamic/json?color=41BDF5&logo=home-assistant&label=integration%20usage&suffix=%20installs&cacheSeconds=15600&url=https%3A%2F%2Fanalytics.home-assistant.io%2Fcustom_integrations.json&query=%24.home_keeper.total&style=for-the-badge [usage]: https://analytics.home-assistant.io/ [downloads-shield]: https://img.shields.io/github/downloads/prestomation/ha-home-keeper/total.svg?style=for-the-badge [releases]: https://github.com/prestomation/ha-home-keeper/releases [release-shield]: https://img.shields.io/github/release/prestomation/ha-home-keeper.svg?style=for-the-badge [release-date-shield]: https://img.shields.io/github/release-date/prestomation/ha-home-keeper?style=for-the-badge [commits-shield]: https://img.shields.io/github/last-commit/prestomation/ha-home-keeper?style=for-the-badge [commits]: https://github.com/prestomation/ha-home-keeper/commits/main [license-shield]: https://img.shields.io/github/license/prestomation/ha-home-keeper.svg?style=for-the-badge [hacs-shield]: https://img.shields.io/badge/HACS-Custom-41BDF5.svg?style=for-the-badge [hacs]: https://github.com/hacs/integration [maintenance-shield]: https://img.shields.io/badge/maintainer-%40prestomation-blue.svg?style=for-the-badge [hacs-validation-shield]: https://github.com/prestomation/ha-home-keeper/actions/workflows/hacs.yml/badge.svg [hacs-validation]: https://github.com/prestomation/ha-home-keeper/actions/workflows/hacs.yml [ha-version-shield]: https://img.shields.io/badge/Home%20Assistant-2024.1%2B-blue.svg?style=for-the-badge [ha-version]: https://www.home-assistant.io/ [docs-shield]: https://img.shields.io/badge/docs-website-03a9f4.svg?style=for-the-badge [docs]: https://prestomation.github.io/ha-home-keeper/ [kofi-shield]: https://img.shields.io/badge/Ko--fi-donate-FF5E5B?style=for-the-badge&logo=kofi&logoColor=white [kofi]: https://ko-fi.com/prestomation