Skip to main content

Add your description here

Project description

RecipeScraper CLI Tool

Version: 0.1.1 Python: >= 3.13

RecipeScraper is a Python command-line tool that extracts recipe information from a given recipe URL. It supports most popular recipe websites that use structured data (JSON-LD) and saves the results in a structured text format.

Features: CLI prompts for a recipe URL, or pass it as an argument Scrapes and extracts: Recipe title Ingredients Instructions (including nested sections) Optional: Equipment list, nutrition info if available Saves the recipe in a formatted .txt file in the current directory Works with most websites that provide recipe metadata in structured formats

Requirements: Python >= 3.13

Dependencies (managed automatically with uv): argparse>=1.4.0 bs4>=0.0.2 requests>=2.32.5 validators>=0.35.0

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

Create and sync the virtual environment: uv sync

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

Or install the package directly with pip: pip install recipescraper-cli-tool-er==0.1.0

Usage: Run the program by passing a URL as an argument: recipescraper https://example.com/recipe-url

Or interactively: python main.py

This will scrape the recipe and save a .txt file in the current directory.

Example Output File: Recipe Title: Polenta Fries Ingredients: 1 cup cornmeal 4 cups water Salt Olive oil Instructions: Preheat the oven to 425°F. Bring water to a boil, add salt. Slowly whisk in cornmeal. Cook until thickened... Planned Features: Support exporting recipes in JSON or Markdown Improved error handling and validation Optional web interface for easier scraping Automatic detection of recipe metadata across more websites

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.1.tar.gz (3.6 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.1-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for recipescraper_cli_tool_er-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a46a54b33e75a1b4dc19a6d5bbd3083533083a80d1858b4986cc38012aee4d3d
MD5 a6efaed327048e8047b2715534d07c27
BLAKE2b-256 63d515bca2ab2af48f9c3e3d13177b9fcc4a357539710e4d5ff1745a4a97e9cb

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for recipescraper_cli_tool_er-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b939c659f0d37ca8eacfbd581887835fe40b95f858b573c2ab673249ff87c5b6
MD5 4afb0923e2a9e508987c3a22b959b7a3
BLAKE2b-256 ccdcf2547c91dc32b9d1e5a59fb06deb5ccd0b8dc5e0f6fba24c3c647e025f3b

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