Utility to scrape recipes and put it in a local Zettelkasten.

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for lcordier from gravatar.com lcordier

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Louis Cordier
  • Tags utility , recipe , scraper , zettelkasten
Classifiers
Report project as malware

Project description

Recipe Box

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

  1. pip install recipe-box

  2. 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.

Acknowledgements

Recipe Box was inspired by Jay Goel's plainoldrecipe.

Recipe Box wouldn't be possible without hhursev's recipe-scrapers.

Contributors

License

Recipe Box is licensed under the MIT license.

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for lcordier from gravatar.com lcordier

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License (MIT)
  • Author: Louis Cordier
  • Tags utility , recipe , scraper , zettelkasten
Classifiers

Release history Release notifications | RSS feed

This version

0.1.3

0.1.2

0.1.1

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

recipe_box-0.1.3.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

recipe_box-0.1.3-py3-none-any.whl (9.0 kB view details)

Uploaded Python 3

File details

Details for the file recipe_box-0.1.3.tar.gz.

File metadata

  • Download URL: recipe_box-0.1.3.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.1

File hashes

Hashes for recipe_box-0.1.3.tar.gz
Algorithm Hash digest
SHA256 f02a8186fe8739626d42462bff47d67bc0acd660c7e31f782edba49b8ba4a54d
MD5 f8139177c1c798df19d332bb61d3c930
BLAKE2b-256 2a46cb1d74d199015fa47a0f9e09fcd4b54b87a2a6ab2cfadb93fb31aa26c4ea

See more details on using hashes here.

File details

Details for the file recipe_box-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: recipe_box-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 9.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.3.1 requests-toolbelt/0.9.1 tqdm/4.46.1 CPython/3.8.1

File hashes

Hashes for recipe_box-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 1148f35a32d1146fc942f02d36ace8bf9a13f3d4f46584e94a1e1482d9b60298
MD5 66385c8aeaa0566a5d2a8a611cee6e65
BLAKE2b-256 3c3193e4cc87ea61cb7efb089cd96c916cee3ed47f6705ddb26d6ee83473d7a4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page