Merge pull request #123 from scrapinghub/more-docs

[docs] minor README.rst cleanup

Author: pawelmhm

.bumpversion.cfg

@@ -1,8 +1,7 @@
 [bumpversion]
-current_version = 0.11.0
+current_version = 0.12.0
 commit = True
 tag = True
 tag_name = {new_version}
 
 [bumpversion:file:scrapyrt/VERSION]
-

README.rst

@@ -24,7 +24,7 @@ Scrapyrt (Scrapy realtime)
 Introduction
 ============
 
-HTTP server which provides API for scheduling Scrapy spiders and
+HTTP server which provides API for scheduling `Scrapy <https://scrapy.org/>`_ spiders and
 making requests with spiders.
 
 Features
@@ -56,9 +56,9 @@ and will raise error if it won't find one.  Note that you need to have all
 your project requirements installed.
 
 Scrapyrt supports endpoint ``/crawl.json`` that can be requested
-with two methods.
+with two methods: GET and POST.
 
-To run sample `toscrape-css spider`_ from `Scrapy educational quotesbot project`_
+To run sample toscrape-css spider from `Quotesbot <https://github.com/scrapy/quotesbot>`_
 parsing page about famous quotes::
 
     curl "http://localhost:9080/crawl.json?spider_name=toscrape-css&url=http://quotes.toscrape.com/"

docs/source/api.rst

@@ -130,6 +130,16 @@ start_requests
     behavior. If this argument is present API will execute start_requests
     Spider method.
 
+crawl_args
+    - type: urlencoded JSON string
+    - optional
+
+    Optional arguments for spider. This is same as you use when running
+    spider from command line with -a argument, for example if you run
+    spider like this: "scrapy crawl spider -a zipcode=14100" you can
+    send crawl_args={"zipcode":"14100"} (urlencoded: crawl_args=%7B%22zipcode%22%3A%2014100%7D)
+    and spider will get zipcode argument.
+
 If required parameters are missing api will return 400 Bad Request
 with hopefully helpful error message.
 
@@ -558,6 +568,18 @@ But if you still want to save all stdout to some file - you can create custom
 approach described in `Python Logging HOWTO`_ or redirect stdout to a file using
 `bash redirection syntax`_, `supervisord logging`_ etc.
 
+Releases
+========
+ScrapyRT 0.12 (2021-03-08)
+--------------------------
+- added crawl arguments for API
+- removed Python 2 support
+- added Python 3.9 support
+- docs clean up
+- removed superfluous requirements (demjson, six)
+- fixed API crash when spider returns bytes in items output
+- updated unit tests
+- development improvements, moved from Travis to Github Workflows
 
 .. _toscrape-css spider: https://github.com/scrapy/quotesbot/blob/master/quotesbot/spiders/toscrape-css.py
 .. _Scrapy educational quotesbot project: https://github.com/scrapy/quotesbot

scrapyrt/VERSION

@@ -1 +1 @@
-0.11.0
+0.12.0