fixed readme

readme.md

@@ -1,42 +1,37 @@
+
 # ComfyUI LoRA Metadata Scraper
 
-This is a Python tool that scans a ComfyUI installation and extracts metadata from `.safetensors` files, including LoRAs, checkpoints, VAEs, and ControlNets. It supports both local metadata extraction and optional scraping of CivitAI metadata, including preview images and videos.
+This is a Python tool to recursively extract metadata from `.safetensors` files inside your ComfyUI installation. It supports both local metadata extraction and optional CivitAI scraping (for trigger words, tags, descriptions, and preview images/videos).
 
-What it does:
-- Extracts embedded metadata from `.safetensors` files
-- Optionally scrapes CivitAI metadata (tags, descriptions, trained words)
-- Downloads preview images and videos
-- Smart deduplication: skips files that already have metadata or previews
-- Lets you scan only the LoRA folder or your entire ComfyUI setup
-- Lets you choose how many preview images/videos to download (or none)
-- Saves previews in a subdirectory or alongside your model files
+Features:
 
---------------------
+- Extracts metadata from LoRAs, checkpoints, VAEs, and ControlNets
+- Optionally scrapes CivitAI data (tags, trigger words, preview images/videos)
+- Skips files that are already processed (unless forced)
+- Lets you scan only the LoRAs folder or the entire ComfyUI setup
+- Saves previews in subdirectories or alongside model files
+- Supports downloading all, none, or a specific number of previews
+- Fully interactive OR command-line friendly
+- Gracefully handles CivitAI rate limiting and retries
 
-## Folder Setup
+Folder Setup:
 
 Place everything inside:
 
-ComfyUI/utils/Scrapertool/
-
-Example structure:
-
 ComfyUI/
 └── utils/
     └── Scrapertool/
-        ├── scraper_run.py
+        ├── scrape_metadata_recursive.py
         ├── requirements.txt
-        └── start.bat  (optional launcher)
+        └── run_scraper.bat  (optional launcher)
 
---------------------
+Usage:
 
-## Usage
-
-### Option 1: Interactive Mode
+Option 1: Interactive Mode
 
 Run:
 
-python scraper_run.py --interactive
+python scrape_metadata_recursive.py --interactive
 
 You’ll be prompted:
 
@@ -47,18 +42,16 @@ D) Scan only the LoRA folder? (Y/N)
 E) Save previews in a subdirectory? (Y/N)
 F) How many preview images/videos to download? (A=All, N=None, or a number)
 
-### Option 2: Command Line Arguments
+Option 2: Command-Line Arguments
 
 Example:
 
-python scraper_run.py --scrape-civitai --delay 0.5 --force --loras-only --previews-subdir --max-media 5
-
---------------------
+python scrape_metadata_recursive.py --scrape-civitai --delay 0.5 --force --loras-only --previews-subdir --max-media 5
 
-## Command-Line Argument Reference
+Command-Line Arguments:
 
 --interactive
-    Launch the interactive menu.
+    Launch interactive menu.
 
 --scrape-civitai
     Enable scraping of metadata and previews from CivitAI.
@@ -67,7 +60,7 @@ python scraper_run.py --scrape-civitai --delay 0.5 --force --loras-only --previe
     Set the delay between API calls and image/video downloads (default: 0.5 seconds).
 
 --force
-    Force re-scraping even if a metadata JSON already exists.
+    Force re-scrape even if metadata JSON already exists.
 
 --loras-only
     Scan only the ComfyUI/models/loras folder. If omitted, scans all subdirectories.
@@ -76,67 +69,56 @@ python scraper_run.py --scrape-civitai --delay 0.5 --force --loras-only --previe
     Save previews inside a dedicated subdirectory (e.g., model_previews/).
 
 --no-previews-subdir
-    Save previews directly next to the model file.
+    Save previews directly alongside the model file.
 
 --max-media [number]
-    Set how many preview images/videos to download. Use 0 to skip all. (Default: unlimited)
-
---------------------
+    Set max number of preview images/videos to download (0 = none, default = all).
 
-## How It Finds CivitAI Metadata
+How It Finds CivitAI Metadata:
 
-1. First, it checks if the `.safetensors` file includes a `civitai_metadata` block (newly fixed!).
-   - If found, it extracts the `civitai_model_id` from that nested block.
-2. If not found, it falls back to looking up the file’s SHA256 hash using the CivitAI API.
+1. First, the script checks if the `.safetensors` file contains a `civitai_metadata` block (fixed in the latest version to look in the correct place).
+2. If that block is missing, it falls back to computing the SHA256 hash and queries CivitAI using that.
 
-This ensures maximum coverage even if metadata is incomplete.
+This ensures compatibility even if metadata is incomplete.
 
---------------------
-
-## Dependencies
-
-This script requires the following Python packages:
+Dependencies:
 
 safetensors
 torch
 requests
 tqdm
 
---------------------
-
-## How to Set Up
+Setup Instructions:
 
-1. Create a virtual environment (recommended):
+1. Create a virtual environment:
 
-   python -m venv scrapervenv
+python -m venv scrapervenv
 
 2. Activate the virtual environment:
 
-   On Windows:
-   scrapervenv\Scripts\activate
+On Windows:
+scrapervenv\Scripts\activate
 
-   On macOS/Linux:
-   source scrapervenv/bin/activate
+On macOS/Linux:
+source scrapervenv/bin/activate
 
 3. Install dependencies:
 
-   pip install -r requirements.txt
+pip install -r requirements.txt
 
---------------------
-
-## requirements.txt
+requirements.txt:
 
 safetensors
 torch
 requests
 tqdm
 
---------------------
-
-## License
+License:
 
 Creative Commons Attribution 4.0 International (CC BY 4.0)
 
-This tool is free to use, share, and adapt for any purpose, including commercial use, as long as you provide attribution to the original creator.
+You may use, share, and adapt this tool for any purpose—including commercial use—as long as you provide attribution to the original creator.
+
+Contributing:
 
---------------------
+Contributions and improvements are welcome. Please fork, submit pull requests, or open an issue if you'd like to suggest features or report bugs.