mirror of https://github.com/SinTan1729/recipe-box-for-wikijs.git synced 2024-12-25 09:48:36 -06:00

Download recipes into a (repurposed Zettelkasten) recipe box.

Find a file

Louis Cordier 24d88449c2 Update docs.		2020-06-27 21:27:46 +02:00
.gitignore	Add more ignores.	2020-06-27 21:14:36 +02:00
LICENSE	Initial commit	2020-06-27 02:27:54 +02:00
README.md	Update docs.	2020-06-27 21:08:51 +02:00
recipe_box.jpg	Add pretty picture.	2020-06-27 14:17:24 +02:00
recipe_box.json	Implement recipe_box.	2020-06-27 02:36:31 +02:00
recipe_box.py	Sane defaults.	2020-06-27 21:05:33 +02:00
requirements.txt	Add requirements.txt.	2020-06-27 03:22:14 +02:00
setup.py	Update docs.	2020-06-27 21:27:46 +02:00

README.md

Recipe Box

This program takes a recipe URL, scrapes the recipe website, converts it to Markdown format and store it in your local Zettelkasten. I use the free Obsidian Zettelkasten software and re-purpose it as a electronic recipe box.

The user can edit the recipe, fix errors, make notes, rate it, add #tags and backlinks to organise his/her collection.

A recipe box can be a treasure chest, but you have to put in some effort.

The idea is not to have the biggest collection of recipes, but to have the most valuable one. The one with the recipes you've personally tested and most of your family love.

Since the recipes are stored in simple plain text files it is easy to share with your friends and family, or pass down to the next generation years from now.

In our age when cloud services can shut down, get bought, or change privacy policy any day, the last thing you want is proprietary formats and data lock-in.

With Obsidian, your data sits in a local folder. Never leave your life's work held hostage in the cloud again.

Plain text Markdown also gives you the unparalleled interoperability to use any kind of sync, encryption, or data processing that works with plain text files.

You could still backup your recipe collection to a private GitHub repository. You could also convert the Markdown files into a PDF and print a physical book as a personalised gift. You'll need those #tags and backlinks to organise it thou.

Installation

pip install recipe-box
Install Obsidian to view the pretty recipes ;)

How To Use

First run recipe_box without parameters to create the config file, $HOME/.config/recipe_box/recipe_box.json

{
    "recipe_box": "~/recipe_box/"
}

Here you can customize the name and location of your recipe box.

Then you are ready to download recipes. Search one of the supported sites for a recipe you like, copy the URL.

$ recipe_box https://www.bbc.co.uk/food/recipes/better_for_you_chocolate_83771

Open Obsidian, open vault and point it to your recipe_box.

Supported Recipe Sites

These sites are scraped by the excellent recipe-scrapers library. To add a new recipe site.