diff --git a/docs/local.rst b/docs/local.rst index 7d285881a..0a80da824 100644 --- a/docs/local.rst +++ b/docs/local.rst @@ -90,3 +90,23 @@ Use data -------- You should now have a crawl directory within the ``data`` directory containing OCDS files. For help using data, read about `using open contracting data `__. + +Integrate with `Kingfisher Process `_ +-------- + +Besides storing the scraped data on disk, you can also send them to an instance of `Kingfisher Process `_ for processing. + +To do that, you need to deploy an instance of Kingfisher Process, including its `web app `__. Then, set the following either as environment variables or as Scrapy settings in ``kingfisher_scrapy.settings.py``: + +``KINGFISHER_API_URI`` + The URL from which Kingfisher Process' `web app `_ is served. Do not include a trailing slash. +``KINGFISHER_API_KEY`` + One of the API keys in Kingfisher Process' `API_KEYS `__ setting. + +For example, set the environment variables, then run ``scrapy crawl`` commands: + +.. code-block:: bash + + export KINGFISHER_API_URI='http://127.0.0.1:5000' + export KINGFISHER_API_KEY=1234 + scrapy crawl my_spider