Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ibensusan/recipe-finder
A Python program that helps users find recipes based on the ingredients they have on hand.
https://github.com/ibensusan/recipe-finder
json python3
Last synced: about 1 month ago
JSON representation
A Python program that helps users find recipes based on the ingredients they have on hand.
- Host: GitHub
- URL: https://github.com/ibensusan/recipe-finder
- Owner: iBensusan
- License: mit
- Created: 2024-11-07T10:57:44.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-11-07T11:04:02.000Z (about 2 months ago)
- Last Synced: 2024-11-16T20:09:58.464Z (about 1 month ago)
- Topics: json, python3
- Language: Python
- Homepage:
- Size: 10.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Recipe Finder
A Python program that helps users find recipes based on the ingredients they have on hand. This tool is designed for intermediate Python learners to practice file handling, JSON parsing, and conditional logic.
## Description
This program is based on a web application with Mediterranean recipes that I developed during my degree. The objective of the original application was to help users find possible recipes they could make using ingredients they already have at home. This Python version serves as a simplified, standalone tool for ingredient-based recipe searching.
## Features
- **Ingredient-Based Recipe Search**: Enter a list of available ingredients, and the program will display recipes that can be made with those ingredients.
- **Detailed Recipe Information**: Shows recipe name, country of origin, description, preparation time, ingredients, and step-by-step instructions.
- **JSON Data Handling**: Reads recipes from a JSON file to dynamically load and search recipes.
## Requirements
- Python 3.x
- `recipes.json` file containing recipe data
## Installation
1. Clone this repository or download the code files.
```bash
git clone https://github.com/username/recipe-finder.git
cd recipe-finder
```
2. Ensure that Python 3.x is installed:
```bash
python --version
```
3. Ensure that the `recipes.json` file is in the same directory as the `recipe_finder.py` script.
## Usage
1. Run the `recipe_finder.py` script:
```bash
python recipe_finder.py
```
2. Enter a list of ingredients, separated by commas (e.g., `rice, saffron, seafood,....`).
3. The program will display recipes that can be made using the specified ingredients, along with details like description, preparation time, instructions, and a video link if available.
## Example Workflow
1. Run the program.
2. Input ingredients you have at home, such as `rice, saffron, seafood, chicken, vegetables`.
3. If recipes match the ingredients you entered, the program will list them with all necessary details, including steps to follow for cooking.
## Files
- `recipe_finder.py`: The main Python script that implements the recipe search functionality.
- `recipes.json`: JSON file containing the recipe data with fields like `name`, `ingredients`, `country`, and `details`.
## License
This project is licensed under the MIT License.