Skip to content

Commit

Permalink
README: better look
Browse files Browse the repository at this point in the history
  • Loading branch information
pawelmhm committed Dec 6, 2021
1 parent 291d748 commit 0789041
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
.. image:: artwork/logo.gif
:width: 400px
:align: center

==========================
Scrapyrt (Scrapy realtime)
ScrapyRT (Scrapy realtime)
==========================

.. image:: https://github.com/scrapinghub/scrapyrt/workflows/CI/badge.svg
Expand All @@ -21,29 +25,41 @@ Scrapyrt (Scrapy realtime)
.. image:: https://readthedocs.org/projects/scrapyrt/badge/?version=latest
:target: https://scrapyrt.readthedocs.io/en/latest/api.html

HTTP API for scheduling `Scrapy <https://scrapy.org/>`_ spiders and receiving their items in response.
Schedule your Scrapy spiders and receive data immediately.

ScrapyRT is a HTTP API for scheduling `Scrapy <https://scrapy.org/>`_ spiders and receiving collected items in response.

Quickstart
===============

**1. install**

.. code-block:: shell
> pip install scrapyrt
**2. switch to Scrapy project (e.g. quotesbot project)**

> cd ../quotesbot
.. code-block:: shell
> cd my/project_path/is/quotesbot
**3. launch ScrapyRT**

.. code-block:: shell
> scrapyrt
**4. run your spiders**

.. code-block:: shell
> curl "localhost:9080/crawl.json?spider_name=toscrape-css&url=http://quotes.toscrape.com/"
**5. run more complex query, e.g. specify callback**

.. code-block:: shell
> curl --data '{"request": {"url": "http://quotes.toscrape.com/page/2/"}, "spider_name": "toscrape-css", "crawl_args": {"callback":"other"}}' http://localhost:9080/crawl.json -v
Scrapyrt will look for ``scrapy.cfg`` file to determine your project settings,
Expand Down
Binary file added artwork/logo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added artwork/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 0789041

Please sign in to comment.