Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add basic docs. #6

Merged
merged 2 commits into from
Oct 27, 2023
Merged

Add basic docs. #6

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f314bd1
Add basic docs.
wRAR Oct 27, 2023
d6e0cb4
Reword the description.
wRAR Oct 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,15 @@ zyte-spider-templates

Spider templates for automatic crawlers.

This library contains Scrapy_ spider templates. They can be used out of the box
with the Zyte features such as `Zyte API`_ or modified to be used standalone.
There is a `sample Scrapy project`_ for this library that you can use as a
starting point for your own projects.

.. _Scrapy: https://docs.scrapy.org/
.. _Zyte API: https://docs.zyte.com/zyte-api/get-started.html
.. _sample Scrapy project: https://github.com/zytedata/zyte-spider-templates-project


Requirements
============
Expand All @@ -35,3 +44,10 @@ Installation
.. code-block::

pip install zyte-spider-templates


Spiders
=======

* ``EcommerceSpider``: a spider that can scrape products from any e-commerce
website.