pyalex 0.12__py3-none-any.whl → 0.13__py3-none-any.whl

pyalex/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.12'
-__version_tuple__ = version_tuple = (0, 12)
+__version__ = version = '0.13'
+__version_tuple__ = version_tuple = (0, 13)

pyalex/api.py

@@ -3,6 +3,7 @@ import warnings
 from urllib.parse import quote_plus
 
 import requests
+from requests.auth import AuthBase
 from urllib3.util import Retry
 
 try:
@@ -22,6 +23,7 @@ class AlexConfig(dict):
 config = AlexConfig(
     email=None,
     api_key=None,
+    user_agent="pyalex/" + __version__,
     openalex_url="https://api.openalex.org",
     max_retries=0,
     retry_backoff_factor=0.1,
@@ -160,6 +162,32 @@ class Paginator:
         return results
 
 
+class OpenAlexAuth(AuthBase):
+    """OpenAlex auth class based on requests auth
+
+    Includes the email, api_key and user-agent headers.
+
+    arguments:
+        config: an AlexConfig object
+
+    """
+
+    def __init__(self, config):
+        self.config = config
+
+    def __call__(self, r):
+        if self.config.api_key:
+            r.headers["Authorization"] = f"Bearer {self.config.api_key}"
+
+        if self.config.email:
+            r.headers["From"] = self.config.email
+
+        if self.config.user_agent:
+            r.headers["User-Agent"] = self.config.user_agent
+
+        return r
+
+
 class BaseOpenAlex:
     """Base class for OpenAlex objects."""
 
@@ -222,13 +250,7 @@ class BaseOpenAlex:
         return m["count"]
 
     def _get_from_url(self, url, return_meta=False):
-        params = {"api_key": config.api_key} if config.api_key else {}
-
-        res = _get_requests_session().get(
-            url,
-            headers={"User-Agent": "pyalex/" + __version__, "email": config.email},
-            params=params,
-        )
+        res = _get_requests_session().get(url, auth=OpenAlexAuth(config))
 
         # handle query errors
         if res.status_code == 403:
@@ -334,11 +356,9 @@ class Work(OpenAlexEntity):
 
     def ngrams(self, return_meta=False):
         openalex_id = self["id"].split("/")[-1]
+        n_gram_url = f"{config.openalex_url}/works/{openalex_id}/ngrams"
 
-        res = _get_requests_session().get(
-            f"{config.openalex_url}/works/{openalex_id}/ngrams",
-            headers={"User-Agent": "pyalex/" + __version__, "email": config.email},
-        )
+        res = _get_requests_session().get(n_gram_url, auth=OpenAlexAuth(config))
         res.raise_for_status()
         results = res.json()
 

{pyalex-0.12.dist-info → pyalex-0.13.dist-info}/METADATA

@@ -1,18 +1,17 @@
 Metadata-Version: 2.1
 Name: pyalex
-Version: 0.12
+Version: 0.13
 Summary: Python interface to the OpenAlex database
 Author-email: Jonathan de Bruin <jonathandebruinos@gmail.com>
 License: MIT
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.6
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Python: >=3.6
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: requests
@@ -21,6 +20,7 @@ Provides-Extra: lint
 Requires-Dist: ruff ; extra == 'lint'
 Provides-Extra: test
 Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: pytest-xdist ; extra == 'test'
 
 <p align="center">
   <img alt="PyAlex - a Python wrapper for OpenAlex" src="https://github.com/J535D165/pyalex/raw/main/pyalex_repocard.svg">
@@ -30,6 +30,9 @@ Requires-Dist: pytest ; extra == 'test'
 
 ![PyPI](https://img.shields.io/pypi/v/pyalex) [![DOI](https://zenodo.org/badge/557541347.svg)](https://zenodo.org/badge/latestdoi/557541347)
 
+[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/J535D165/pyalex/badge)](https://securityscorecards.dev/viewer/?uri=github.com/J535D165/pyalex)
+
+
 PyAlex is a Python library for [OpenAlex](https://openalex.org/). OpenAlex is
 an index of hundreds of millions of interconnected scholarly papers, authors,
 institutions, and more. OpenAlex offers a robust, open, and free [REST API](https://docs.openalex.org/) to extract, aggregate, or search scholarly data.
@@ -60,7 +63,7 @@ We aim to cover the entire API, and we are looking for help. We are welcoming Pu
 
 ## Installation
 
-PyAlex requires Python 3.6 or later.
+PyAlex requires Python 3.8 or later.
 
 ```sh
 pip install pyalex
@@ -412,6 +415,8 @@ R users can use the excellent [OpenAlexR](https://github.com/ropensci/openalexR)
 
 ## Contact
 
+> This library is a community contribution. The authors of this Python library aren't affiliated with OpenAlex.
+
 Feel free to reach out with questions, remarks, and suggestions. The
 [issue tracker](/issues) is a good starting point. You can also email me at
 [jonathandebruinos@gmail.com](mailto:jonathandebruinos@gmail.com).

pyalex-0.13.dist-info/RECORD

@@ -0,0 +1,8 @@
+pyalex/__init__.py,sha256=UrEW9s9NbULtmmnYUUgfbrDujleV8XQLiMRYGdRnm9M,1137
+pyalex/_version.py,sha256=4Ti_UJ2UR2LyAc9zW9aeUVpFeq-DXxy65V2wynOuCi0,408
+pyalex/api.py,sha256=vefNV54OG1daTrKHSDq9Jcy4JhiYi0HSP3GsEzA47uk,11633
+pyalex-0.13.dist-info/LICENSE,sha256=Mhf5MImRYP06a1EPVJCpkpTstOOEfGajN3T_Fz4izMg,1074
+pyalex-0.13.dist-info/METADATA,sha256=vMMbnCUgNUaw99XlqucQZMfZsOZWrXXJOmRpPJsTdSU,12916
+pyalex-0.13.dist-info/WHEEL,sha256=Xo9-1PvkuimrydujYJAjF7pCkriuXBpUPEjma1nZyJ0,92
+pyalex-0.13.dist-info/top_level.txt,sha256=D0An8hWy9e0xPhTaT6K-yuJKVeVV3bYGxZ6Y-v2WXSU,7
+pyalex-0.13.dist-info/RECORD,,

{pyalex-0.12.dist-info → pyalex-0.13.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.41.2)
+Generator: bdist_wheel (0.41.3)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pyalex-0.12.dist-info/RECORD

@@ -1,8 +0,0 @@
-pyalex/__init__.py,sha256=UrEW9s9NbULtmmnYUUgfbrDujleV8XQLiMRYGdRnm9M,1137
-pyalex/_version.py,sha256=eOKjFr4-OgtTmAgooUIWvbplNekszFVZVHe7TLPOdeU,408
-pyalex/api.py,sha256=lmbJaU3GCwi2ZNeshQV0dFXK-j83A08q1yjuVdeEKeM,11193
-pyalex-0.12.dist-info/LICENSE,sha256=Mhf5MImRYP06a1EPVJCpkpTstOOEfGajN3T_Fz4izMg,1074
-pyalex-0.12.dist-info/METADATA,sha256=JVSzitj9HrRO7us_49vrDWCYIVLe7QtvRNIGGk0tQQU,12632
-pyalex-0.12.dist-info/WHEEL,sha256=yQN5g4mg4AybRjkgi-9yy4iQEFibGQmlz78Pik5Or-A,92
-pyalex-0.12.dist-info/top_level.txt,sha256=D0An8hWy9e0xPhTaT6K-yuJKVeVV3bYGxZ6Y-v2WXSU,7
-pyalex-0.12.dist-info/RECORD,,