crossref: extract email setting

Author: Gerit Wagner

colrev/packages/crossref/src/crossref_api.py

@@ -16,7 +16,6 @@
 import requests_cache
 from rapidfuzz import fuzz
 
-import colrev.env.environment_manager
 import colrev.exceptions as colrev_exceptions
 import colrev.record.record_prep
 import colrev.utils
@@ -329,15 +328,21 @@ def __init__(
         self,
         *,
         url: str,
+        email="my@email.edu",
         rerun: bool = False,
         cache: typing.Optional[bool] = None,
     ):
         assert url.startswith(self._api_url)
         self.url = url
 
-        _, self.email = (
-            colrev.env.environment_manager.EnvironmentManager.get_name_mail_from_git()
-        )
+        self.email = email
+        if email == "my@email.edu":
+            # warn
+            print(
+                "Warning: Using default email for Crossref API. "
+                "Please set a valid email to comply with Crossref's polite usage policy."
+            )
+
         self.rerun = rerun
         # default: disable cache in CI; but allow explicit override
         if cache is None:
@@ -619,4 +624,4 @@ def query_doi(*, doi: str) -> colrev.record.record_prep.PrepRecord:
     except (requests.exceptions.RequestException, StopIteration) as exc:
         raise colrev_exceptions.RecordNotFoundInPrepSourceException(
             msg="Record not found in crossref (based on doi)"
-        ) from exc
+        ) from exc

colrev/packages/crossref/src/crossref_search_source.py

@@ -11,7 +11,7 @@
 
 import inquirer
 from pydantic import Field
-
+import colrev.env.environment_manager
 import colrev.env.language_service
 import colrev.exceptions as colrev_exceptions
 import colrev.ops.search_api_feed
@@ -75,7 +75,10 @@ def __init__(
         else:
             url = self.search_source.search_parameters["url"]
 
-        self.api = crossref_api.CrossrefAPI(url=url)
+        _, email = (
+            colrev.env.environment_manager.EnvironmentManager.get_name_mail_from_git()
+        )
+        self.api = crossref_api.CrossrefAPI(url=url, email=email)
 
     def _validate_source(self) -> None:
         # validate version and migrate if needed