scrapy Getting started with scrapy

30% OFF - 9th Anniversary discount on Entity Framework Extensions until December 15 with code: ZZZANNIVERSARY9


This section provides an overview of what scrapy is, and why a developer might want to use it.

It should also mention any large subjects within scrapy, and link out to the related topics. Since the Documentation for scrapy is new, you may need to create initial versions of those related topics.


VersionRelease Date

Creating a project

Before starting work with scrapy you have to start a project where you want to store your code. Enter the directory and run this code

scrapy startproject helloProject

The third part of this code is project name. This code will create a "helloProject" directory with the following contents:

    scrapy.cfg            # deploy configuration file

    helloProject/         # project's Python module, you'll import your code from here          # project items file      # project pipelines file       # project settings file

        spiders/          # a directory where you'll later put your spiders

Installation of Scrapy

prerequisite of scrapy installation:

  • Python 2.7 or above 3.3
  • pip and setuptools Python packages.
  • lxml
  • OpenSSL.

You can install Scrapy using pip. To install using pip run:

pip install Scrapy

Platform specific installation


This is the recommended way to install Scrapy.

If you already have installed Anaconda or Miniconda, the company Scrapinghub maintains official conda packages for Linux, Windows and OS X.

To install Scrapy using conda, run:

conda install -c scrapinghub scrapy

Ubuntu 9.10 or above

Use the official Ubuntu Packages, which already solve all dependencies for you and are continuously updated with the latest bug fixes.

If you prefer to build the python dependencies locally instead of relying on system packages you’ll need to install their required non-python dependencies first:

sudo apt-get install python-dev python-pip libxml2-dev libxslt1-dev zlib1g-dev libffi-dev libssl-dev

You can install Scrapy with pip after that:

pip install Scrapy


You can follow the generic instructions or install Scrapy from AUR Scrapy package:

yaourt -S scrapy


Scrapy with Python 3 is not yet supported on Windows.

Follow This steps to install scrapy on windows:

  • Install Python 2.7

  • adjust PATH environment variable to include paths to the Python executable and additional scripts. The following paths need to be added to PATH:


  • Install pywin32 from here

  • let’s install Scrapy:

     pip install Scrapy

Mac OS X

Building Scrapy’s dependencies requires the presence of a C compiler and development headers. On OS X this is typically provided by Apple’s Xcode development tools. To install the Xcode command line tools open a terminal window and run:

xcode-select --install

There’s a known issue that prevents pip from updating system packages. This has to be addressed to successfully install Scrapy and its dependencies. Here are some proposed solutions:

  • (Recommended) Don’t use system python, install a new, updated version that doesn’t conflict with the rest of your system. Here’s how to do it using the homebrew package manager:

    • Install homebrew following the instructions in

    • Update your PATH variable to state that homebrew packages should be used before system packages (Change .bashrc to .zshrc accordantly if you’re using zsh as default shell):

      echo "export PATH=/usr/local/bin:/usr/local/sbin:$PATH" >> ~/.bashrc
    • Reload .bashrc to ensure the changes have taken place:

      source ~/.bashrc
    • Install python:

      brew install python
    • Latest versions of python have pip bundled with them so you won’t need to install it separately. If this is not the case, upgrade python:

      brew update; brew upgrade python
  • (Optional) Install Scrapy inside an isolated python environment.

    This method is a workaround for the above OS X issue, but it’s an overall good practice for managing dependencies and can complement the first method.

    virtualenv is a tool you can use to create virtual environments in python. We recommended reading a tutorial like to get started.

After any of these workarounds you should be able to install Scrapy:

pip install Scrapy

Got any scrapy Question?