API Reference

Reference documentation generated from the docstrings of Silkworm’s public modules.

Module

Contents

silkworm

Spiders, requests, responses, the engine, runners, convenience helpers, and client adapters

silkworm.middlewares

Built-in request, response, and exception middlewares

silkworm.pipelines

Built-in item pipelines

silkworm.declarative

Declarative item extraction

silkworm.markdown

HTML-to-Markdown conversion

silkworm.types

Public type aliases and protocols

silkworm.exceptions

Exception hierarchy

silkworm.logging

Logger helpers

silkworm.settings

Layered engine settings (environment, custom_settings, explicit)

silkworm.testing

Offline spider testing helpers

silkworm.httpcache

On-disk HTTP response cache

silkworm.cli

The silkworm command line