Skip to main content

Add your description here

Project description

RecipeScraper

Version: 0.1.0

RecipeScraper is a Python tool that extracts recipe information from a given recipe URL. Currently, it supports PreppyKitchen.com, with plans to expand support for more recipe websites in future versions.

Features: Prompts the user for a recipe URL.

Scrapes and extracts: Recipe title Equipment list Ingredients Instructions

Saves the recipe in a formatted .txt file inside the txt_files/ folder.

Requirements: Python 3.13.3 or higher uv (https://github.com/astral-sh/uv) for virtual environment and dependency management

Installation: Clone this repository: git clone https://github.com/yourusername/RecipeScraper.git cd RecipeScraper

Create and sync the virtual environment with uv: uv sync

Activate the environment: source .venv/bin/activate (Linux / macOS) .venv\Scripts\activate (Windows)

Usage: Run the program: python main.py

You will be prompted to enter a recipe URL (currently only works with PreppyKitchen.com). After running, a .txt file will be generated in the txt_files/ directory containing the scraped recipe.

Example Output File: Recipe Title: Rice Pudding Equipment: saucepan, whisk, spatula Ingredients: 1 cup rice 2 cups milk 1/2 cup sugar

Instructions: Heat the milk... Stir in the rice...

Limitations (v0.1.0): Only works with PreppyKitchen.com Basic scraping (does not handle images, nutrition info, etc.) Planned Features Support for more recipe websites (using JSON-LD structured data). Better error handling and validation. Option to export recipes in JSON or Markdown format. CLI arguments instead of interactive input.

Dependencies: bs4>=0.0.2 requests>=2.32.5 validators>=0.35.0

Dependencies are managed automatically with uv.

License: MIT License

Project details


Download files

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

Source Distribution

recipescraper_cli_tool_er-0.1.0.tar.gz (3.5 kB view details)

Uploaded Source

Built Distribution

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

recipescraper_cli_tool_er-0.1.0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file recipescraper_cli_tool_er-0.1.0.tar.gz.

File metadata

File hashes

Hashes for recipescraper_cli_tool_er-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fd689cd9d2825e43102e32da16718b380177a1c7e8372f4d1238cad447b5a75b
MD5 f4ba658ab35a750aa9a869e4bcb7d748
BLAKE2b-256 83d1bba0d48601b559d1e85fbd96cf8a7fb7c1c8046012004f1ebdaa72fb4b62

See more details on using hashes here.

File details

Details for the file recipescraper_cli_tool_er-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for recipescraper_cli_tool_er-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ede9efaec23f317fafc3263b338d00a07d36f5d84eadc983509cdc33ba38c29c
MD5 1dd4da8e4121f6b3d6432342fb10bb1c
BLAKE2b-256 da81a4143f4b129375cfec9bfb02ab84e05c0daa0353e61bcbb2c3687d4aecc5

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