Skip to main content

scrapy-calyprium

Anti-detection Scrapy middleware for web scraping — proxy routing and stealth browser rendering powered by Calyprium.

Install

pip install scrapy-calyprium

Quick Start

# settings.py
import scrapy_calyprium

scrapy_calyprium.configure(api_key="clp_your_key_here")

This auto-configures:

  • VeilProxyMiddleware — routes requests through rotating proxies with TLS fingerprinting
  • MimicBrowserMiddleware — renders JavaScript pages with stealth browser instances
  • S3 feed storage — write spider output to Calyprium storage using Scrapy's built-in S3FeedStorage

Usage

# settings.py
import scrapy_calyprium

scrapy_calyprium.configure(
    api_key="clp_your_key_here",
    mimic_stealth_level="maximum",  # basic, moderate, maximum
)

Manual Configuration

# settings.py
DOWNLOADER_MIDDLEWARES = {
    "scrapy_calyprium.VeilProxyMiddleware": 100,
    "scrapy_calyprium.MimicBrowserMiddleware": 200,
}

CALYPRIUM_API_KEY = "clp_your_key_here"
VEIL_USER_ID = "your-user-id"

Request Tracing

CalypriumTraceMiddleware (added by configure()) gives every request one trace: the wait in Scrapy's queue, each download attempt, the challenge solve if there is one, and the callback that parses the page. The SDK's calls to Mimic and Tessera carry the trace (traceparent), so their steps join it. On the Calyprium platform the trace of every request of a run is shown with its run. To set it up by hand, register it as both a downloader and a spider middleware:

DOWNLOADER_MIDDLEWARES = {"scrapy_calyprium.CalypriumTraceMiddleware": 50}
SPIDER_MIDDLEWARES = {"scrapy_calyprium.CalypriumTraceMiddleware": 50}

Saving Output to Calyprium Storage

Spider output is saved to Calyprium's S3-compatible storage using Scrapy's built-in feed export:

# settings.py
import scrapy_calyprium

scrapy_calyprium.configure(api_key="clp_your_key_here")

FEEDS = {
    "s3://calyprium/my-spider/%(time)s.jl": {
        "format": "jsonlines",
    },
}

The S3 credentials are auto-configured by configure() — no additional setup needed.

Browser Rendering

Mark requests that need JavaScript rendering:

import scrapy

class MySpider(scrapy.Spider):
    name = "example"

    def start_requests(self):
        # Regular request (proxy only)
        yield scrapy.Request("https://example.com")

        # Browser-rendered request
        yield scrapy.Request(
            "https://example.com/spa",
            meta={"mimic": True},
        )

Authentication

All middleware requires a valid API key. Set it via:

  1. scrapy_calyprium.configure(api_key="clp_...")
  2. CALYPRIUM_API_KEY environment variable

Settings Reference

Setting Description Default
CALYPRIUM_API_KEY API key for all services —
VEIL_GATEWAY_URL Proxy gateway URL https://proxy.calyprium.com
VEIL_USER_ID User ID for proxy routing —
VEIL_PROFILE Proxy routing profile —
VEIL_PROXY_TYPE datacenter, residential, residential_rotating —
MIMIC_SERVICE_URL Mimic browser service URL https://mimic.calyprium.com
MIMIC_STEALTH_LEVEL basic, moderate, maximum moderate
MIMIC_BROWSER_ENGINE Specific browser engine auto
MIMIC_USE_PROXY Route browser through proxy False
MIMIC_ALL_REQUESTS Render all requests via browser False
MIMIC_USE_SPECTRE Use device fingerprints True

License

MIT

Metadata

Release files for scrapy-calyprium 1.31.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for scrapy-calyprium 1.31.0
File Size Uploaded Provenance
scrapy_calyprium-1.31.0.tar.gz 153.0 kB With provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for scrapy-calyprium 1.31.0
File Interpreter ABI Platform
scrapy_calyprium-1.31.0-py3-none-any.whl Python 3 none any Details

Total release size: 266.0 kB

Release files / scrapy_calyprium-1.31.0.tar.gz

Download URL scrapy_calyprium-1.31.0.tar.gz
Size 153.0 kB
Tags Source
SHA-256 checksum
How to use checksums
2ffd49d51df132cd401bf4686a38afa2d04d176c205d424691b5ec202bf5e701
BLAKE2b-256 checksum
How to use checksums
dab318c00f6912b9be3f8558acee7f60589192539a50b220af57e866f19f6dac
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.

Transparency log

Release files / scrapy_calyprium-1.31.0-py3-none-any.whl

Download URL scrapy_calyprium-1.31.0-py3-none-any.whl
Size 113.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
22dd5bc3d8f31178bc4687b4d6199b1c7540d06ea58eda3a601ec966bbdec6f7
BLAKE2b-256 checksum
How to use checksums
6b074361ae34318db050f7b71dc525667231e15b7d1020657d57675c1b940feb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.

Transparency log

Security for scrapy-calyprium 1.31.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

All 2 files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for scrapy_calyprium-1.31.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 17, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Release history Release notifications | RSS feed

This release

1.31.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page