Skip to content

Commit

Permalink
Add docs about kingfisher process integration
Browse files Browse the repository at this point in the history
Signed-off-by: Yohanna Lisnichuk <yohanitalisnichuk@gmail.com>
  • Loading branch information
yolile committed Jun 1, 2020
1 parent 4e634fb commit 548d591
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/local.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,3 +90,20 @@ 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 <https://www.open-contracting.org/data/data-use/>`__.

Integrate with `Kingfisher Process <https://kingfisher-process.readthedocs.io/>`_
--------

Besides storing the scraped data on disk, you can also send them to an instance of `Kingfisher Process <https://kingfisher-process.readthedocs.io/>`_ for processing.

To do that, you need to have deployed an instance of `Kingfisher Process web app <https://kingfisher-process.readthedocs.io/en/latest/web.html#web-app>`_ and set the following environment variables:

* ``KINGFISHER_API_URI``: The url where Kingfisher Process `web app <https://kingfisher-process.readthedocs.io/en/latest/web.html#web-app>`_ is served
* ``KINGFISHER_API_KEY``: The Api Key configured for Kingfisher Process `web app <https://kingfisher-process.readthedocs.io/en/latest/config.html#web-api>`_

For example:

.. code-block:: bash
export KINGFISHER_API_URI = 'http://127.0.0.1:5000'
export KINGFISHER_API_KEY = 1234

0 comments on commit 548d591

Please sign in to comment.