Skip to main content

scrapy-jsonrpc is an extension to control a running Scrapy web crawler via JSON-RPC. The service provides access to the main Crawler object via the JSON-RPC 2.0 protocol.

It’s enabled by the JSONRPC_ENABLED setting. The web server will listen in the port specified in JSONRPC_PORT, and will log to the file specified in JSONRPC_LOGFILE.

The endpoint for accessing the crawler object is:

http://localhost:6080/crawler

Example client

There is a command line tool provided for illustration purposes on how to build a client. You can find it in example-client.py. It supports a few basic commands such as listing the running spiders, etc.

Settings

These are the settings that control the web service behaviour:

JSONRPC_ENABLED

Default: True

A boolean which specifies if the web service will be enabled (provided its extension is also enabled).

JSONRPC_LOGFILE

Default: None

A file to use for logging HTTP requests made to the web service. If unset web the log is sent to standard scrapy log.

JSONRPC_PORT

Default: [6080, 7030]

The port range to use for the web service. If set to None or 0, a dynamically assigned port is used.

JSONRPC_HOST

Default: '127.0.0.1'

The interface the web service should listen on.

Release files for scrapy-jsonrpc 0.3.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-jsonrpc 0.3.0
File Size Uploaded
scrapy-jsonrpc-0.3.0.tar.gz 5.2 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for scrapy-jsonrpc 0.3.0
File Interpreter ABI Platform
scrapy_jsonrpc-0.3.0-py2-none-any.whl Python 2 none any Details

Total release size: 12.0 kB

Release files / scrapy-jsonrpc-0.3.0.tar.gz

Download URL scrapy-jsonrpc-0.3.0.tar.gz
Size 5.2 kB
Tags Source
SHA-256 checksum
How to use checksums
d03381e2f3ba6ab6f2b67584df681e9c613847452187b18dffd3d6342e7b9bf3
BLAKE2b-256 checksum
How to use checksums
5187a19ea34b012ef68dcd5a3bbb2849fa345744b0e7c4620a102498e1a52785
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release files / scrapy_jsonrpc-0.3.0-py2-none-any.whl

Download URL scrapy_jsonrpc-0.3.0-py2-none-any.whl
Size 6.9 kB
Tags Python 2
SHA-256 checksum
How to use checksums
7144c3b4878e49470a53dee353ff9d21a8001431ebe24dce13d8604403fd263f
BLAKE2b-256 checksum
How to use checksums
7c64b7450af507272474f8e845d22a49807378e782ce8a641c7972bdbccb75f1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files

0.2.0

2 release files

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