matmatyk / weekly_fridge_qrmenu

Generates HTML file with QR codes linking to recipes.

weekly_fridge_qrmenu

Table of Contents

• weekly_fridge_qrmenu
  • Table of Contents
  • About The Project
  • Getting Started
    • Prerequisites
    • Installation
  • Usage
    • Example
  • Roadmap
  • Contributing
  • License
  • Contact

About The Project

TLDR; put into a text file your lunch recipes for next few days and generate printable HTML file with QR codes which link directly to the recipes!

Idea: I came across this idea during social distancing phase of COVID-19 epidemic. I decided to prepare a lunch menu for circa 10 – 14 days, print it and put on the fridge. Additional plus of such planning is that very likely it will be enough to make a shopping just once per two weeks!

This Python module does exactly that. Generates HTML file with QR codes linking to recipes.

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

This script is written in Python 3. Additionally you will need pip3 to install dependencies.

Installation

1. Clone the repo

   git clone https://github.com/matmatyk/weekly_fridge_qrmenu.git

2. Install required dependencies

   pip3 install -r requirements.txt

Usage

Go to source directory and run as python module

python3 -m weekly_fridge_qrmenu path/to/menu_file.json

or shell script

./weekly_fridge_qrmenu.sh path/to/menu_file.json

In outcome you het an html file in output directory, which you can open using your web browser and print.

Example

We will use here exemplary input file..

1. Run ./weekly_fridge_qrmenu.py example_input/menu.json
2. Open the result file in your favourite browser, eg. chromium output/menu_2020-04-28.html
3. Print it horizontally on A4 paper:
4. Put on your fridge:

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

matmatyk - @matmatyk

Project Link: https://github.com/matmatyk/weekly_fridge_qrmenu