Using Zyte API from Scrapy Cloud#

Following this guide you will learn how to deploy your Scrapy project from the Zyte API tutorial into Scrapy Cloud, and run your spiders on the cloud.

Before you start to follow this guide, you need to:

Deploy your Scrapy project to Scrapy Cloud#

Now that you have a Scrapy project that uses Zyte API, you will deploy it to a Scrapy Cloud project.

  1. Install shub, the Scrapy Cloud command-line application:

    pip install --upgrade shub
  2. Create a text file at zyte-api-tutorial/requirements.txt with the following content:

  3. Create a YAML file at zyte-api-tutorial/scrapinghub.yml with the following content:

      file: requirements.txt
      default: scrapy:2.7
  4. Copy your Zyte dashboard API key.

  5. Run the following command and, when prompted, paste your API key and press Enter:

    shub login
  6. On the Zyte dashboard, select your Scrapy Cloud project under Scrapy Cloud Projects, and copy your Scrapy Cloud project ID from the web browser URL bar.

    For example, if the URL is, 000000 is your Scrapy Cloud project ID.

  7. Make sure zyte-api-tutorial is your current working folder.

  8. Run the following command, replacing 000000 with your actual project ID:

    shub deploy 000000

Your Scrapy project has now been deployed to your Scrapy Cloud project.

Run a Scrapy Cloud job#

Now that you have deployed your Scrapy project to your Scrapy Cloud project, it is time to run one of your spiders on Scrapy Cloud:

  1. On the Zyte dashboard, select your Scrapy Cloud project under Scrapy Cloud Projects.

  2. On the Dashboard page of your project, select Run on the top-right corner.

  3. On the Run dialog box:

    1. Select the Spiders field and, from the spider list that appears, select your spider name.

    2. Select Run.


    A new Scrapy Cloud job will appear in the Running job list:

    Once the job finishes, it will move to the Completed job list:

  4. Follow the link from the Job column, 1/1.

  5. On the job page, select the Items tab.

  6. On the Items page, select Export → CSV.

The downloaded file will have the same data as the books.csv file that you generated locally earlier.

Next steps#

Now that you know how to deploy your code and run a job in Scrapy Cloud, see Scrapy Cloud usage for more in-depth documentation of Scrapy Cloud.