/scrapling

name: scrapling
description: Scrape web pages using Scrapling with anti-bot bypass (like Cloudflare Turnstile), stealth headless browsing, spiders framework, adaptive scraping, and JavaScript rendering. This skill should be used when asked to scrape, crawl, or extract data from websites; web_fetch fails; the site has anti-bot protections; write Python code to scrape/crawl; write spiders.
version: 0.4.2
license: Complete terms in LICENSE.txt

Scrapling

Scrapling is an adaptive Web Scraping framework that handles everything from a single request to a full-scale crawl.

Its parser learns from website changes and automatically relocates your elements when pages update. Its fetchers bypass anti-bot systems like Cloudflare Turnstile out of the box. And its spider framework lets you scale up to concurrent, multi-session crawls with pause/resume and automatic proxy rotation — all in a few lines of Python. One library, zero compromises.

Blazing fast crawls with real-time stats and streaming. Built by Web Scrapers for Web Scrapers and regular users, there's something for everyone.

**Requires: Python 3.10+**

**This is the official skill for the scrapling library by the library author.**

Setup (once)

Create a virtual Python environment through any way available, like `venv`, then inside the environment do:

`pip install "scrapling[all]>=0.4.2"`

Then do this to download all the browsers' dependencies:

scrapling install --force

Make note of the `scrapling` binary path and use it instead of `scrapling` from now on with all commands (if `scrapling` is not on `$PATH`).

Docker

Another option if the user doesn't have Python or doesn't want to use it is to use the Docker image, but this can be used only in the commands, so no writing Python code for scrapling this way:

docker pull pyd4vinci/scrapling

or

docker pull ghcr.io/d4vinci/scrapling:latest

CLI Usage

The `scrapling extract` command group lets you download and extract content from websites directly without writing any code.

Usage: scrapling extract [OPTIONS] COMMAND [ARGS]...

Commands:
  get             Perform a GET request and save the content to a file.
  post            Perform a POST request and save the content to a file.
  put             Perform a PUT request and save the content to a file.
  delete          Perform a DELETE request and save the content to a file.
  fetch           Use a browser to fetch content with browser automation and flexible options.
  stealthy-fetch  Use a stealthy browser to fetch content with advanced stealth features.

Usage pattern

• Choose your output format by changing the file extension. Here are some examples for the `scrapling extract get` command:
• Convert the HTML content to Markdown, then save it to the file (great for documentation): `scrapling extract get "https://blog.example.com" article.md`
• Save the HTML content as it is to the file: `scrapling extract get "https://example.com" page.html`
• Save a clean version of the text content of the webpage to the file: `scrapling extract get "https://example.com" content.txt`
• Output to a temp file, read it back, then clean up.
• All commands can use CSS selectors to extract specific parts of the page through `--css-selector` or `-s`.

Which command to use generally:

• Use **`get`** with simple websites, blogs, or news articles.
• Use **`fetch`** with modern web apps, or sites with dynamic content.
• Use **`stealthy-fetch`** with protected sites, Cloudflare, or anti-bot systems.

> When unsure, start with `get`. If it fails or returns empty content, escalate to `fetch`, then `stealthy-fetch`. The speed of `fetch` and `stealthy-fetch` is nearly the same, so you are not sacrificing anything.

Key options (requests)

Those options are shared between the 4 HTTP request commands:

| Option | Input type | Description | |:-------------------------------------------|:----------:|:-----------------------------------------------------------------------------------------------------------------------------------------------| | -H, --headers | TEXT | HTTP headers in format "Key: Value" (can be used multiple times) | | --cookies | TEXT | Cookies string in format "name1=value1; name2=value2" | | --timeout | INTEGER | Request timeout in seconds (default: 30) | | --proxy | TEXT | Proxy URL in format "http://username:password@host:port" | | -s, --css-selector | TEXT | CSS selector to extract specific content from the page. It returns all matches. | | -p, --params | TEXT | Query parameters in format "key=value" (can be used multiple times) | | --follow-redirects / --no-follow-redirects | None | Whether to follow redirects (default: True) | | --verify / --no-verify | None | Whether to verify SSL certificates (default: True) | | --impersonate | TEXT | Browser to impers