Skip to main content

Scrapy spider middleware to use Scrapinghub's Hub Crawl Frontier as a backend for URLs

Project description

This Scrapy spider middleware uses the HCF backend from Scrapinghub’s Scrapy Cloud service to retrieve the new urls to crawl and store back the links extracted.


Install scrapy-hcf using pip:

$ pip install scrapy-hcf


To activate this middleware it needs to be added to the SPIDER_MIDDLEWARES dict, i.e:

    'scrapy_hcf.HcfMiddleware': 543,

And the following settings need to be defined:


Scrapy Cloud API key


Scrapy Cloud project ID (not needed if the spider is ran on dash)


Frontier name.


Slot from where the spider will read new URLs.

Note that HS_FRONTIER and HS_CONSUME_FROM_SLOT can be overriden from inside a spider using the spider attributes hs_frontier and hs_consume_from_slot respectively.

The following optional Scrapy settings can be defined:


URL to the API endpoint, i.e: http://localhost:8003. The default value is provided by the python-hubstorage package.


Number of links to be read from the HCF, the default is 1000.


Enable whether to start a new job when the spider finishes. The default is False


This is a list of closing reasons, if the spider ends with any of these reasons a new job will be started for the same slot. The default is ['finished']


This is the number of slots that the middleware will use to store the new links. The default is 8.


The following keys can be defined in a Scrapy Request meta in order to control the behavior of the HCF middleware:


If set to True the request will be stored in the HCF.


Dictionary of parameters to be stored in the HCF with the request fingerprint


data to be stored along with the fingerprint in the request queue


data to be stored along with the fingerprint in the fingerprint set


Priority - lower priority numbers are returned first. The default is 0

The value of 'qdata' parameter could be retrieved later using response.meta['hcf_params']['qdata'].

The spider can override the default slot assignation function by setting the spider slot_callback method to a function with the following signature:

def slot_callback(request):
    return slot

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

scrapy-hcf-1.0.0.tar.gz (4.4 kB view hashes)

Uploaded source

Built Distribution

scrapy_hcf-1.0.0-py2.py3-none-any.whl (4.8 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page