Deprecate IGNORED_INGREDIENTS environment variable (#24)

Remove support for `IGNORED_INGREDIENTS` and replace it with a new
ingredient management system to mark certain items as always on hand.
Updated documentation and included a new image to guide users on
configuring ignored ingredients through the UI instead.

Co-authored-by: Iture

Author: felixschndr

README.md

@@ -11,6 +11,10 @@ Mealie instance and adds the ingredients of a recipe to a specified Bring shoppi
 > [!IMPORTANT]  
 > This integration does only support Mealie version >= `2` which was [released in October 2024](https://github.com/mealie-recipes/mealie/releases/tag/v2.0.0). The support for Mealie version < `2` was deprecated in https://github.com/felixschndr/mealie-bring-api/pull/17.
 
+> [!IMPORTANT]  
+> The environment variable `IGNORED_INGREDIENTS` was deprecated in [PR24](https://github.com/felixschndr/mealie-bring-api/pull/24) and is now ignored. If you are using it, migrate to the
+new way of configuring which ingredients shall be ignored. See [down below](https://github.com/felixschndr/mealie-bring-api?tab=readme-ov-file#ignoring-ingredients)
+
 ## Architecture
 
 ### Without this project
@@ -41,14 +45,25 @@ No matter which deployment option you chose you must setup some environment vari
 | `BRING_USERNAME`      | The email address of your bring account                                                                                                                                                                                                                                                    |   Yes    | -                                 | `[email protected]`   |
 | `BRING_PASSWORD`      | The password of your bring account                                                                                                                                                                                                                                                         |   Yes    | -                                 | `my super secret password`     |
 | `BRING_LIST_NAME`     | The exact name of the list you want to add the ingredients to, supports special characters                                                                                                                                                                                                 |   Yes    | -                                 | `My shopping list with spaces` |
-| `IGNORED_INGREDIENTS` | Ingredients that are never added to the shopping list (things you always have at home), separated by a `,`, case insensitive, **WARNING**: This *only* works for recipes with *enabled* ingredient amounts in the recipe settings! ![recipe settings](./assets/images/recipe_settings.png) |    No    | - (all ingredients will be added) | `Salt,Pepper,Frying oil`       |
 | `LOG_LEVEL`           | The loglevel the application logs at                                                                                                                                                                                                                                                       |    No    | `INFO`                            | `DEBUG`                        |
 | `HTTP_HOST`           | The address the application tries to attach to, leave this empty to listen on all interfaces, leave this empty if you are using Docker                                                                                                                                                     |    No    | `0.0.0.0`                         | `192.168.1.5`                  |
 | `HTTP_PORT`           | The port the application listens on, change this if needed if you run the application locally, leave this empty if you are using Docker                                                                                                                                                    |    No    | `8742`                            | `1234`                         |
 | `HTTP_BASE_PATH`      | The path the application listens on. Use this if you use the app behind a reverse proxy and have setup a path (e.g. set this to `/bring` if the application shall listen on `<mealie>.<yourdomain>.tld/bring`)                                                                             |    No    | `""`                              | `/bring`                       |
 
 Ensure to quote your environment variables. Without quotes your password might not be read properly if it contains symbols such as `<`, `&` or `;`.
 
+#### Ignoring ingredients
+
+It is possible to define ingredients that shall never be added to the shopping list. These are ingredients you always have at home (e.g., salt and pepper).
+
+To do so
+1. Open the `Data Management` (under `<your mealie domain>/group/data/foods/`).
+2. Search for the ingredient you don't want to be added to the shopping list.
+3. Click on the edit button.
+4. Enable the checkbox `On Hand`.
+
+   ![](assets/images/food_on_hand.png)
+
 ### Deployment options
 
 You can run this app in three simple ways. I prefer the third option. Depending on the deployment option you chose

assets/images/food_on_hand.png

@@ -64,8 +64,8 @@ def _get_note(raw_data: dict) -> str:
         return f"({raw_data['note']})"
 
     @staticmethod
-    def is_ignored(name_of_ingredient: str, ignored_ingredients: list[Ingredient]) -> bool:
-        return name_of_ingredient.lower() in [ingredient.name for ingredient in ignored_ingredients]
+    def in_household(raw_data: dict) -> bool:
+        return len(raw_data["food"].get("households_with_ingredient_food", [])) > 0
 
     def to_dict(self) -> dict:
         return {"itemId": self.name, "spec": self.specification, "uuid": str(uuid.uuid4())}

source/ingredient.py

@@ -36,9 +36,8 @@ def webhook_handler() -> str:
             # This often is the case when a recipe is imported from some source and not properly formatted yet
             ingredients_to_add.append(IngredientWithAmountsDisabled.from_raw_data(ingredient_raw_data))
         else:
-            name_of_ingredient = ingredient_raw_data["food"]["name"]
-            if Ingredient.is_ignored(name_of_ingredient, ignored_ingredients):
-                logger.log.debug(f"Ignoring ingredient {name_of_ingredient}")
+            if Ingredient.in_household(ingredient_raw_data):
+                logger.log.info(f"Ignoring ingredient {ingredient_raw_data["food"]["name"]}")
                 continue
             ingredients_to_add.append(Ingredient.from_raw_data(ingredient_raw_data))
 
@@ -55,19 +54,15 @@ def status_handler() -> str:
     return "OK"
 
 
-def parse_ignored_ingredients() -> list[Ingredient]:
+def check_for_ignored_ingredients() -> None:
     try:
-        ignored_ingredients_input = EnvironmentVariableGetter.get("IGNORED_INGREDIENTS")
-    except RuntimeError:
-        logger.log.info(
-            "The variable IGNORED_INGREDIENTS is not set. All ingredients will be added. "
-            'Consider setting the variable to something like "Salt,Pepper"'
+        EnvironmentVariableGetter.get("IGNORED_INGREDIENTS")
+        logger.log.warning(
+            "The variable IGNORED_INGREDIENTS is deprecated and ignored! "
+            "Take a look README.md for more information on how to ignore ingredients."
         )
-        return []
-
-    ignored_ingredients_raw = ignored_ingredients_input.replace(", ", ",").split(",")
-    logger.log.info(f"Ignoring ingredients {ignored_ingredients_raw}")
-    return [Ingredient(name.lower()) for name in ignored_ingredients_raw]
+    except RuntimeError:
+        pass
 
 
 if __name__ == "__main__":
@@ -76,8 +71,9 @@ def parse_ignored_ingredients() -> list[Ingredient]:
     loop = asyncio.new_event_loop()
     asyncio.set_event_loop(loop)
 
+    check_for_ignored_ingredients()
+
     bring_handler = BringHandler(loop)
-    ignored_ingredients = parse_ignored_ingredients()
 
     host = EnvironmentVariableGetter.get("HTTP_HOST", "0.0.0.0")
     port = int(EnvironmentVariableGetter.get("HTTP_PORT", 8742))