udata-hydra 2.0.0.dev3084__tar.gz → 2.0.0.dev3133__tar.gz

{udata_hydra-2.0.0.dev3084 → udata_hydra-2.0.0.dev3133}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: udata-hydra
-Version: 2.0.0.dev3084
+Version: 2.0.0.dev3133
 Summary: Async crawler and parsing service for data.gouv.fr
 License: MIT
 Author: Opendata Team
@@ -124,6 +124,22 @@ You can also override the coverage report configuration when running the tests b
 
 ## API
 
+The API will need a Bearer token for each request on protected endpoints (any endpoint that isn't a `GET`).
+The token is configured in the `config.toml` file as `API_KEY`, and has a default value set in the `udata_hydra/config_default.toml` file.
+
+If you're using hydra as an external service to receive resource events from [udata](https://github.com/opendatateam/udata), then udata needs to also configure this
+API key in its `udata.cfg` file:
+
+```
+# Wether udata should publish the resource events
+PUBLISH_ON_RESOURCE_EVENTS = True
+# Where to publish the events
+RESOURCES_ANALYSER_URI = "http://localhost:8000"
+# The API key that hydra needs
+RESOURCES_ANALYSER_API_KEY = "api_key_to_change"
+
+```
+
 ### Run
 
 ```bash

{udata_hydra-2.0.0.dev3084 → udata_hydra-2.0.0.dev3133}/README.md

@@ -87,6 +87,22 @@ You can also override the coverage report configuration when running the tests b
 
 ## API
 
+The API will need a Bearer token for each request on protected endpoints (any endpoint that isn't a `GET`).
+The token is configured in the `config.toml` file as `API_KEY`, and has a default value set in the `udata_hydra/config_default.toml` file.
+
+If you're using hydra as an external service to receive resource events from [udata](https://github.com/opendatateam/udata), then udata needs to also configure this
+API key in its `udata.cfg` file:
+
+```
+# Wether udata should publish the resource events
+PUBLISH_ON_RESOURCE_EVENTS = True
+# Where to publish the events
+RESOURCES_ANALYSER_URI = "http://localhost:8000"
+# The API key that hydra needs
+RESOURCES_ANALYSER_API_KEY = "api_key_to_change"
+
+```
+
 ### Run
 
 ```bash

{udata_hydra-2.0.0.dev3084 → udata_hydra-2.0.0.dev3133}/pyproject.toml

@@ -9,7 +9,7 @@ readme = "README.md"
 
 [tool.poetry]
 name = "udata-hydra"
-version = "2.0.0.dev3084"
+version = "2.0.0.dev3133"
 description = "Async crawler and parsing service for data.gouv.fr"
 authors = ["Opendata Team <opendatateam@data.gouv.fr>"]
 license = "MIT"