pyalex 0.14__py3-none-any.whl → 0.15.1__py3-none-any.whl

pyalex/__init__.py

@@ -27,8 +27,6 @@ from pyalex.api import Subfield
 from pyalex.api import Subfields
 from pyalex.api import Topic
 from pyalex.api import Topics
-from pyalex.api import Venue
-from pyalex.api import Venues
 from pyalex.api import Work
 from pyalex.api import Works
 from pyalex.api import autocomplete
@@ -46,8 +44,6 @@ __all__ = [
     "Funders",
     "Publishers",
     "Publisher",
-    "Venues",
-    "Venue",
     "Institutions",
     "Institution",
     "Concepts",

pyalex/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.14'
-__version_tuple__ = version_tuple = (0, 14)
+__version__ = version = '0.15.1'
+__version_tuple__ = version_tuple = (0, 15, 1)

pyalex/api.py

@@ -23,7 +23,7 @@ class AlexConfig(dict):
 config = AlexConfig(
     email=None,
     api_key=None,
-    user_agent="pyalex/" + __version__,
+    user_agent=f"pyalex/{__version__}",
     openalex_url="https://api.openalex.org",
     max_retries=0,
     retry_backoff_factor=0.1,
@@ -31,12 +31,28 @@ config = AlexConfig(
 )
 
 
+def _quote_oa_value(v):
+    """Prepare a value for the OpenAlex API.
+
+    Applies URL encoding to strings and converts booleans to lowercase strings.
+    """
+
+    # workaround for bug https://groups.google.com/u/1/g/openalex-users/c/t46RWnzZaXc
+    if isinstance(v, bool):
+        return str(v).lower()
+
+    if isinstance(v, str):
+        return quote_plus(v)
+
+    return v
+
+
 def _flatten_kv(d, prefix=""):
     if isinstance(d, dict):
         t = []
         for k, v in d.items():
             if isinstance(v, list):
-                t.extend([f"{prefix}.{k}:{i}" for i in v])
+                t.extend([f"{prefix}.{k}:{_quote_oa_value(i)}" for i in v])
             else:
                 new_prefix = f"{prefix}.{k}" if prefix else f"{k}"
                 x = _flatten_kv(v, prefix=new_prefix)
@@ -44,10 +60,7 @@ def _flatten_kv(d, prefix=""):
 
         return ",".join(t)
     else:
-        # workaround for bug https://groups.google.com/u/1/g/openalex-users/c/t46RWnzZaXc
-        d = str(d).lower() if isinstance(d, bool) else d
-
-        return f"{prefix}:{d}"
+        return f"{prefix}:{_quote_oa_value(d)}"
 
 
 def _params_merge(params, add_params):
@@ -199,10 +212,11 @@ class BaseOpenAlex:
 
     def _full_collection_name(self):
         if self.params is not None and "q" in self.params.keys():
-            base_url = config.openalex_url + "/autocomplete/"
-            return base_url + self.__class__.__name__.lower()
+            return (
+                f"{config.openalex_url}/autocomplete/{self.__class__.__name__.lower()}"
+            )
         else:
-            return config.openalex_url + "/" + self.__class__.__name__.lower()
+            return f"{config.openalex_url}/{self.__class__.__name__.lower()}"
 
     def __getattr__(self, key):
         if key == "groupby":
@@ -223,7 +237,7 @@ class BaseOpenAlex:
             return self._get_multi_items(record_id)
 
         return self._get_from_url(
-            self._full_collection_name() + "/" + record_id, return_meta=False
+            f"{self._full_collection_name()}/{record_id}", return_meta=False
         )
 
     @property
@@ -236,15 +250,14 @@ class BaseOpenAlex:
             if v is None:
                 pass
             elif isinstance(v, list):
-                v_quote = [quote_plus(q) for q in v]
-                l_params.append(k + "=" + ",".join(v_quote))
+                l_params.append("{}={}".format(k, ",".join(map(_quote_oa_value, v))))
             elif k in ["filter", "sort"]:
-                l_params.append(k + "=" + _flatten_kv(v))
+                l_params.append(f"{k}={_flatten_kv(v)}")
             else:
-                l_params.append(k + "=" + quote_plus(str(v)))
+                l_params.append(f"{k}={_quote_oa_value(v)}")
 
         if l_params:
-            return self._full_collection_name() + "?" + "&".join(l_params)
+            return "{}?{}".format(self._full_collection_name(), "&".join(l_params))
 
         return self._full_collection_name()
 
@@ -294,6 +307,8 @@ class BaseOpenAlex:
 
     def paginate(self, method="cursor", page=1, per_page=None, cursor="*", n_max=10000):
         if method == "cursor":
+            if self.params.get("sample"):
+                raise ValueError("method should be 'page' when using sample")
             value = cursor
         elif method == "page":
             value = page
@@ -464,50 +479,31 @@ class autocompletes(BaseOpenAlex):
 
     def __getitem__(self, key):
         return self._get_from_url(
-            config.openalex_url + "/autocomplete" + "?q=" + key, return_meta=False
+            f"{config.openalex_url}/autocomplete?q={key}", return_meta=False
         )
 
 
-def Venue(*args, **kwargs):  # deprecated
-    # warn about deprecation
-    warnings.warn(
-        "Venue is deprecated. Use Sources instead.",
-        DeprecationWarning,
-        stacklevel=2,
-    )
-
-    return Source(*args, **kwargs)
-
-
-def Venues(*args, **kwargs):  # deprecated
-    # warn about deprecation
-    warnings.warn(
-        "Venues is deprecated. Use Sources instead.",
-        DeprecationWarning,
-        stacklevel=2,
-    )
-
-    return Sources(*args, **kwargs)
-
-
 class Concept(OpenAlexEntity):
-    # warn about deprecation
-    warnings.warn(
-        "Concept is deprecated by OpenAlex and replaced by topics.",
-        DeprecationWarning,
-        stacklevel=2,
-    )
+    def __init__(self, *args, **kwargs):
+        warnings.warn(
+            "Concept is deprecated by OpenAlex and replaced by topics.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(*args, **kwargs)
 
 
 class Concepts(BaseOpenAlex):
-    # warn about deprecation
-    warnings.warn(
-        "Concepts is deprecated by OpenAlex and replaced by topics.",
-        DeprecationWarning,
-        stacklevel=2,
-    )
     resource_class = Concept
 
+    def __init__(self, *args, **kwargs):
+        warnings.warn(
+            "Concepts is deprecated by OpenAlex and replaced by topics.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        super().__init__(*args, **kwargs)
+
 
 def autocomplete(s):
     """autocomplete with any type of entity"""

{pyalex-0.14.dist-info → pyalex-0.15.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyalex
-Version: 0.14
+Version: 0.15.1
 Summary: Python interface to the OpenAlex database
 Author-email: Jonathan de Bruin <jonathandebruinos@gmail.com>
 License: MIT
@@ -123,7 +123,7 @@ Works()["W2741809807"]["open_access"]
 {'is_oa': True, 'oa_status': 'gold', 'oa_url': 'https://doi.org/10.7717/peerj.4375'}
 ```
 
-The previous works also for Authors, Venues, Institutions, Concepts and Topics
+The previous works also for Authors, Sources, Institutions, Concepts and Topics
 
 ```python
 Authors()["A2887243803"]
@@ -378,6 +378,18 @@ Works()["W2023271753"].ngrams()
 ```
 
 
+### Serialize
+
+All results from PyAlex can be serialized. For example, save the results to a JSON file:
+
+```python
+with open(Path("works.json"), "w") as f:
+    json.dump(Works().get(), f)
+
+with open(Path("works.json")) as f:
+    works = [Work(w) for w in json.load(f)]
+```
+
 ## Code snippets
 
 A list of awesome use cases of the OpenAlex dataset.
@@ -441,9 +453,6 @@ pyalex.config.api_key = "<MY_KEY>"
 
 ## Alternatives
 
-[Diophila](https://github.com/smierz/diophila) is a nice Python wrapper for OpenAlex. It takes a slightly
-different approach, especially interesting to those who don't like the pipe operations.
-
 R users can use the excellent [OpenAlexR](https://github.com/ropensci/openalexR) library.
 
 ## License

pyalex-0.15.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+pyalex/__init__.py,sha256=52XK8om6IVD1Yiq_HYOCR6PUY56sPRHutGM03NOrGMQ,1467
+pyalex/_version.py,sha256=po5_rvCFTU8xU9IC56wyK0-zfBgz_U4xX6CO2mv9Mzs,413
+pyalex/api.py,sha256=JTOx0P037IOhhYVAigQO5uPsd1HMQC-SM3wny0_52uU,13236
+pyalex-0.15.1.dist-info/LICENSE,sha256=Mhf5MImRYP06a1EPVJCpkpTstOOEfGajN3T_Fz4izMg,1074
+pyalex-0.15.1.dist-info/METADATA,sha256=JSa8cKcjZUZ-lDo28WyuFN1GHEEWUHWLvSLaKh3IP10,13859
+pyalex-0.15.1.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+pyalex-0.15.1.dist-info/top_level.txt,sha256=D0An8hWy9e0xPhTaT6K-yuJKVeVV3bYGxZ6Y-v2WXSU,7
+pyalex-0.15.1.dist-info/RECORD,,

{pyalex-0.14.dist-info → pyalex-0.15.1.dist-info}/WHEEL

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

pyalex-0.14.dist-info/RECORD

@@ -1,8 +0,0 @@
-pyalex/__init__.py,sha256=EL6oh0vQdSNyvsrxFFgmDn-P_Dgev1IYpP-WiLBxjS8,1553
-pyalex/_version.py,sha256=lmFPHiet63Bn9h104yd9q0T6i7C2c0WCbizqrpAtSuk,408
-pyalex/api.py,sha256=whUv8TbnW968wlR8U4O-lWsaFHRgW0Ham0cznbR3Zlc,13212
-pyalex-0.14.dist-info/LICENSE,sha256=Mhf5MImRYP06a1EPVJCpkpTstOOEfGajN3T_Fz4izMg,1074
-pyalex-0.14.dist-info/METADATA,sha256=3bjn78df3VlosFCcseDGs5tfTUIAgCStI_uGjqHT69w,13777
-pyalex-0.14.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-pyalex-0.14.dist-info/top_level.txt,sha256=D0An8hWy9e0xPhTaT6K-yuJKVeVV3bYGxZ6Y-v2WXSU,7
-pyalex-0.14.dist-info/RECORD,,