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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: udata-hydra
-Version: 2.0.0.dev3046
+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.dev3046 → 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.dev3046 → udata_hydra-2.0.0.dev3133}/pyproject.toml

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

{udata_hydra-2.0.0.dev3046 → udata_hydra-2.0.0.dev3133}/udata_hydra/__init__.py

@@ -1,21 +1,25 @@
+import logging
 import os
 from pathlib import Path
 
 import toml
 
+log = logging.getLogger("udata-hydra")
+
 
 class Configurator:
     """Loads a dict of config from TOML file(s) and behaves like an object, ie config.VALUE"""
 
-    configuration = None
+    configuration: dict = {}
 
     def __init__(self):
         if not self.configuration:
             self.configure()
+            self.load_pyproject_info()
 
     def configure(self) -> None:
         # load default settings
-        configuration = toml.load(Path(__file__).parent / "config_default.toml")
+        configuration: dict = toml.load(Path(__file__).parent / "config_default.toml")
 
         # override with local settings
         local_settings = os.environ.get("HYDRA_SETTINGS", Path.cwd() / "config.toml")
@@ -25,6 +29,15 @@ class Configurator:
         self.configuration = configuration
         self.check()
 
+    def load_pyproject_info(self) -> None:
+        """Get more info about the app from pyproject.toml"""
+        try:
+            project_info: dict = toml.load("pyproject.toml")["project"]
+        except Exception as e:
+            log.error(f"Error while getting pyproject.toml info: {str(e)}")
+        self.configuration["APP_NAME"] = project_info.get("name")
+        self.configuration["APP_VERSION"] = project_info.get("version")
+
     def override(self, **kwargs) -> None:
         self.configuration.update(kwargs)
         self.check()

{udata_hydra-2.0.0.dev3046 → udata_hydra-2.0.0.dev3133}/udata_hydra/logger.py

@@ -8,7 +8,6 @@ from sentry_sdk.integrations.aiohttp import AioHttpIntegration
 from sentry_sdk.integrations.rq import RqIntegration
 
 from udata_hydra import config
-from udata_hydra.utils import get_app_version
 
 log = logging.getLogger("udata-hydra")
 context = {"inited": False}
@@ -17,10 +16,6 @@ context = {"inited": False}
 def setup_logging() -> logging.Logger:
     if context.get("inited"):
         return log
-    release = "hydra@unknown"
-    app_version: Optional[str] = get_app_version()
-    if app_version:
-        release = f"hydra@{app_version}"
     if config.SENTRY_DSN:
         sentry_sdk.init(
             dsn=config.SENTRY_DSN,
@@ -28,7 +23,7 @@ def setup_logging() -> logging.Logger:
                 AioHttpIntegration(),
                 RqIntegration(),
             ],
-            release=release,
+            release=f"{config.APP_NAME}@{config.APP_VERSION}",
             environment=os.getenv("HYDRA_ENV", "unknown"),
             # Set traces_sample_rate to 1.0 to capture 100%
             # of transactions for performance monitoring.

{udata_hydra-2.0.0.dev3046 → udata_hydra-2.0.0.dev3133}/udata_hydra/utils/__init__.py

@@ -1,4 +1,3 @@
-from .app_version import get_app_version
 from .auth import token_auth_middleware
 from .csv import detect_tabular_from_headers
 from .file import compute_checksum_from_file, download_resource, read_csv_gz

udata_hydra-2.0.0.dev3046/udata_hydra/utils/app_version.py

@@ -1,17 +0,0 @@
-import logging
-from typing import Optional
-
-import toml
-
-log = logging.getLogger("udata-hydra")
-
-
-def get_app_version() -> Optional[str]:
-    """Get the app version from pyproject.toml"""
-    try:
-        pyproject: dict = toml.load("pyproject.toml")
-        app_version: str = pyproject["tool"]["poetry"]["version"]
-        return app_version
-    except Exception as e:
-        log.error(f"Error while getting app version: {e}")
-        return None