Skip to main content

Scrapy extenstion to control spiders using JSON-RPC

Project description

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.

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-jsonrpc-0.3.0.tar.gz (5.2 kB view details)

Uploaded Source

Built Distribution

scrapy_jsonrpc-0.3.0-py2-none-any.whl (6.9 kB view details)

Uploaded Python 2

File details

Details for the file scrapy-jsonrpc-0.3.0.tar.gz.

File metadata

File hashes

Hashes for scrapy-jsonrpc-0.3.0.tar.gz
Algorithm Hash digest
SHA256 d03381e2f3ba6ab6f2b67584df681e9c613847452187b18dffd3d6342e7b9bf3
MD5 0dd4553c6051381310fb0f71059a4ad7
BLAKE2b-256 5187a19ea34b012ef68dcd5a3bbb2849fa345744b0e7c4620a102498e1a52785

See more details on using hashes here.

Provenance

File details

Details for the file scrapy_jsonrpc-0.3.0-py2-none-any.whl.

File metadata

File hashes

Hashes for scrapy_jsonrpc-0.3.0-py2-none-any.whl
Algorithm Hash digest
SHA256 7144c3b4878e49470a53dee353ff9d21a8001431ebe24dce13d8604403fd263f
MD5 8fa4b2f14904486f2c2590ae4d56a777
BLAKE2b-256 7c64b7450af507272474f8e845d22a49807378e782ce8a641c7972bdbccb75f1

See more details on using hashes here.

Provenance

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