Skip to main content

An extension that allows a user to display all or some of their scrapy spider settings at runtime.

Project description

Scrapy Settings Log

An extension that allows a user to display all or some of their scrapy spider settings at runtime. It will add a logline with some or all settings for your spider in JSON compatible format.

Install

pip install scrapy-settings-log

Quick-Start

Add the following to your settings:

EXTENSIONS = {
    'scrapy_settings_log.SpiderSettingsLogging': 999,
}

SETTINGS_LOGGING_ENABLED = True

When you run your spider you will see a log like below when spider is closing:

[scrapy_settings_log] INFO: {"SETTINGS_LOGGING_ENABLED": true, ...}

Additional Options

  • SETTINGS_LOGGING_REGEX - Add a regular expression to only show some settings - for example SETTINGS_LOGGING_REGEX = "SPIDERMON" will show settings with SPIDERMON in their name.
  • SETTINGS_LOGGING_INDENT - Add indentation to make log more human-readable.

Advanced

Subclass and override the output_settings method if you want the settings to be reported in another way.

from scrapy_settings_log import SpiderSettingsLogging

class CustomSettingsLogger(SpiderSettingsLogging):

    def  output_settings(self, settings: dict, spider: scrapy.Spider):
        # custom code here

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-settings-log-1.3.4.tar.gz (15.7 kB view hashes)

Uploaded Source

Built Distribution

scrapy_settings_log-1.3.4-py3-none-any.whl (15.2 kB view hashes)

Uploaded Python 3

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