Skip to content
Fetching contributors…
Cannot retrieve contributors at this time
239 lines (166 sloc) 5.17 KB

Scrapy |version| documentation

This documentation contains everything you need to know about Scrapy.

Getting help

Having trouble? We'd like to help!

First steps

:doc:`intro/overview`
Understand what Scrapy is and how it can help you.
:doc:`intro/install`
Get Scrapy installed on your computer.
:doc:`intro/tutorial`
Write your first Scrapy project.
:doc:`intro/examples`
Learn more by playing with a pre-made Scrapy project.

Basic concepts

:doc:`topics/commands`
Learn about the command-line tool used to manage your Scrapy project.
:doc:`topics/items`
Define the data you want to scrape.
:doc:`topics/spiders`
Write the rules to crawl your websites.
:doc:`topics/selectors`
Extract the data from web pages.
:doc:`topics/shell`
Test your extraction code in an interactive environment.
:doc:`topics/loaders`
Populate your items with the extracted data.
:doc:`topics/item-pipeline`
Post-process and store your scraped data.
:doc:`topics/feed-exports`
Output your scraped data using different formats and storages.
:doc:`topics/link-extractors`
Convenient classes to extract links to follow from pages.

Built-in services

:doc:`topics/logging`
Understand the simple logging facility provided by Scrapy.
:doc:`topics/stats`
Collect statistics about your scraping crawler.
:doc:`topics/email`
Send email notifications when certain events occur.
:doc:`topics/telnetconsole`
Inspect a running crawler using a built-in Python console.
:doc:`topics/webservice`
Monitor and control a crawler using a web service.

Solving specific problems

:doc:`faq`
Get answers to most frequently asked questions.
:doc:`topics/firefox`
Learn how to scrape with Firefox and some useful add-ons.
:doc:`topics/firebug`
Learn how to scrape efficiently using Firebug.
:doc:`topics/leaks`
Learn how to find and get rid of memory leaks in your crawler.
:doc:`topics/images`
Download static images associated with your scraped items.
:doc:`topics/ubuntu`
Install latest Scrapy packages easily on Ubuntu
:doc:`topics/scrapyd`
Deploying your Scrapy project in production.
:doc:`topics/jobs`
Learn how to pause and resume crawls for large spiders.

Extending Scrapy

:doc:`topics/architecture`
Understand the Scrapy architecture.
:doc:`topics/downloader-middleware`
Customize how pages get requested and downloaded.
:doc:`topics/spider-middleware`
Customize the input and output of your spiders.
:doc:`topics/extensions`
Add any custom functionality using :doc:`signals <topics/signals>` and the Scrapy API

Reference

:doc:`topics/commands`
Learn about the command-line tool and see all :ref:`available commands <topics-commands-ref>`.
:doc:`topics/request-response`
Understand the classes used to represent HTTP requests and responses.
:doc:`topics/settings`
Learn how to configure Scrapy and see all :ref:`available settings <topics-settings-ref>`.
:doc:`topics/signals`
See all available signals and how to work with them.
:doc:`topics/exceptions`
See all available exceptions and their meaning.
:doc:`topics/exporters`
Quickly export your scraped items to a file (XML, CSV, etc).

All the rest

:doc:`contributing`
Learn how to contribute to the Scrapy project.
:doc:`versioning`
Understand Scrapy versioning and API stability.
:doc:`experimental/index`
Learn about bleeding-edge features.
Something went wrong with that request. Please try again.