WebScraper.pro / README.md
LovnishVerma's picture
Update README.md
903a1f6 verified
metadata
title: WebScraper Pro
emoji: πŸ•ΈοΈ
colorFrom: indigo
colorTo: purple
sdk: docker
app_port: 7860
pinned: false

πŸ•·οΈ WebScraper.pro β€” Premium Web Scraping Platform

Python Version Flask Version Playwright License: MIT

WebScraper.pro is a professional, secure, and production-ready web scraping platform built on Python and Flask. It provides a visual dashboard to configure, manage, and schedule scraping jobs targeting both static pages and modern dynamic (JavaScript-rendered) websites, exporting cleanly to JSON, CSV, or Excel.

Designed with a premium dark-mode visual interface featuring glassmorphism elements, dynamic micro-animations, and live job status polling.


Live Demo:

https://lovnishverma-webscraper-pro.hf.space

webscraping

🌟 Key Features

  • ⚑ Dual Scraping Engines:
    • Static Engine: Fast, lightweight HTTP requests combined with BeautifulSoup4 parsing.
    • Dynamic Engine: Headless Playwright integration for complex, client-side, JavaScript-heavy SPAs.
  • πŸ“Š Premium Real-Time Dashboard:
    • Live-updating analytics cards (success rates, items scraped, running jobs).
    • Auto-refreshing status progress bars and real-time console log stream.
  • πŸ”Ž Granular Visual Extractors:
    • Select data via CSS Selectors, XPath Expressions, HTML Tags, or HTML Attributes.
    • Custom configurations for Table Data, JSON-LD Schema, and Full HTML extractions.
  • βš™οΈ Enterprise Crawl Controls:
    • Auto-rotating random User Agents per request.
    • Adaptive request throttling (custom delays) and automatic retry policies.
    • Infinite scroll triggers (custom scroll depth) and standard pagination crawling.
    • Full support for custom HTTP request headers (JSON format).
  • πŸ”’ Production-Grade Security:
    • High-performance request rate limiting powered by Flask-Limiter.
    • Industry-standard Cross-Site Request Forgery (CSRFProtect) protection.
    • Strict security headers (CSP, X-Frame-Options, X-Content-Type) and sanitize filters (bleach).
  • πŸ“₯ Multi-Format Exporters: Export scraped datasets on-demand to structured JSON, CSV, or Microsoft Excel (.xlsx).

πŸ—οΈ Modular Architecture

The platform has been re-architected from a flat layout into a highly maintainable, standardized Application Factory Blueprint structure:

webscraping/
β”œβ”€β”€ app/
β”‚   β”œβ”€β”€ __init__.py           # Application Factory initialization
β”‚   β”œβ”€β”€ config/               # Settings & Environment configurations
β”‚   β”œβ”€β”€ models/               # SQLAlchemy ORM schemas (BaseModel, User, ScrapeJob, etc.)
β”‚   β”œβ”€β”€ scrapers/             # Core Scraping Engine (Static & Playwright)
β”‚   β”œβ”€β”€ services/             # Job Execution, Excel/CSV Exports, Statistics calculations
β”‚   β”œβ”€β”€ middleware/           # Rate limiting and Security headers middleware
β”‚   β”œβ”€β”€ routes/               # Modular controller Blueprints (Main, Jobs)
β”‚   β”œβ”€β”€ utils/                # Input validation & Logging configurators
β”‚   β”œβ”€β”€ templates/            # HTML templates (dashboard, job details, forms)
β”‚   └── static/               # Premium custom CSS, JS assets
β”œβ”€β”€ run.py                    # Production-ready entry point
β”œβ”€β”€ .env                      # Environment secrets
└── requirements.txt          # Package dependencies

πŸš€ Quick Start

πŸ“‹ Prerequisites

  • Python 3.10 or higher
  • Node.js (required for Playwright browsers dependency)

1. Clone & Set Up Directory

git clone https://github.com/your-username/webscraper-pro.git
cd webscraper-pro

2. Configure Virtual Environment

python -m venv venv
# On Windows (PowerShell)
.\venv\Scripts\Activate.ps1
# On macOS/Linux
source venv/bin/activate

3. Install Dependencies

pip install -r requirements.txt
playwright install chromium

4. Setup Environment Variables

Create a .env file in the root directory. You can copy the example file:

cp env.example .env

Open .env and set up your application environment details:

# Core
FLASK_APP=app
FLASK_ENV=development
SECRET_KEY=generate-a-strong-random-key-here
DEBUG=True

# Database (Leave commented out to use default SQLite)
# DATABASE_URL=sqlite:///database/scraper.db

5. Launch the Server

python run.py

The application will start, seed database configurations automatically, and be accessible at http://127.0.0.1:5000.


πŸ› οΈ Configuration Settings (.env)

Variable Type Default Description
FLASK_ENV String production Environment type (development or production)
SECRET_KEY String Required Secret key for session encryption & CSRF tokens
DEBUG Boolean False Enables or disables interactive debug tools
DATABASE_URL String sqlite:///database/scraper.db Target database connection URI
RATELIMIT_DEFAULT String 100 per minute Default global API rate limit constraint

πŸ”’ Security Compliance

This platform enforces secure engineering best practices:

  • Input Sanitization: Uses bleach and custom content validators to strip dangerous Javascript/HTML injection payloads before database commit.
  • Robust Rate-Limiting: Defends against scraping-abuse/DoS using local in-memory window limitation schemas.
  • Strict Headers: Employs security middleware to restrict frame injection, content sniffing, and force standard CORS controls.

πŸ“„ License

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

Test

Test on Aaj Tak (Hindi News). News websites are excellent targets for scraping because they are rich in constantly updating structured data.

Here are the three most valuable things you can scrape from this page, along with exactly how to fill out your configuration form for each!

πŸ’‘ Option 1: The Easiest & Cleanest Data (JSON-LD Metadata)

News sites embed hidden structured data for Google. This page has a massive ItemList JSON-LD block containing the top 20+ trending headlines and their exact URLs. This is the cleanest way to get the top stories without dealing with messy HTML tags.

  • Job Name: AajTak Top Stories (JSON)
  • Target URL: https://www.aajtak.in/
  • Scrape Type: Static (Requests + BS4)
  • Extraction Type: JSON-LD Schema
  • CSS Selector: (Leave blank)
  • Delay Between Requests (s): 2

πŸ’‘ Option 2: Scraping All Article Headlines (Text)

If you want to pull the visible text of every news headline on the page (Top stories, Sports, Entertainment, Tech, etc.).

  • Job Name: AajTak All Headlines
  • Target URL: https://www.aajtak.in/
  • Scrape Type: Static (Requests + BS4)
  • Extraction Type: Text Content
  • CSS Selector: .title h3, .fv-cap h3, .sstitle-listing h3, .title-big h3
  • Delay Between Requests (s): 2

πŸ’‘ Option 3: Scraping Article URLs (Links)

If your goal is to build a crawler that finds news articles to scrape their full text later, you need the URLs of the articles.

  • Job Name: AajTak Article Links
  • Target URL: https://www.aajtak.in/
  • Scrape Type: Static (Requests + BS4)
  • Extraction Type: HTML Attributes
  • CSS Selector: li[data-tb-region-item] a
  • Attribute Name: href

πŸ’‘ Option 4: Scraping Thumbnail Images

Note: Because this site uses "lazy loading" for performance, the actual image URL isn't in the standard src attribute; it's hidden in data-src.

  • Job Name: AajTak Thumbnails
  • Target URL: https://www.aajtak.in/
  • Scrape Type: Static (Requests + BS4)
  • Extraction Type: HTML Attributes
  • CSS Selector: img.lazyload
  • Attribute Name: data-src