openalex-reporting 0.1.0__py3-none-any.whl

oar/__init__.py

@@ -0,0 +1,48 @@
+"""OAR — a bibliometric warehouse for any set of OpenAlex works.
+
+    import oar
+
+    oar.build(name="epfl", institution="I5124864")
+    oar.indicators()                  # output, impact, collaboration, open access
+    oar.baseline(country="CH")        # the same indicators for a reference set
+    oar.partners()                    # who the set publishes with
+
+The build reads OAM for the work set and the citation scores, and the OpenAlex
+API for titles, authors and affiliations. The result is one DuckDB file. After
+that, nothing here needs OAM or the network.
+
+See the README for the indicators and for what a baseline compares against.
+"""
+
+import re
+from importlib.metadata import PackageNotFoundError, version
+from pathlib import Path
+
+from .build import build, status
+from .config import set_data_dir
+from .db import connect
+from .doc import doc
+from .indicators import baseline, indicators, partners, works
+
+
+def _package_version():
+    try:
+        return version("openalex-reporting")
+    except PackageNotFoundError:
+        text = (Path(__file__).resolve().parents[1] / "pyproject.toml").read_text()
+        match = re.search(r'(?m)^version = "([^"]+)"', text)
+        if match is None:
+            raise RuntimeError("pyproject.toml has no version")
+        return match.group(1)
+
+
+__version__ = _package_version()
+
+__all__ = [
+    "baseline", "build", "connect", "doc", "indicators", "partners",
+    "set_data_dir", "status", "works",
+]
+
+
+def __dir__():
+    return sorted(__all__ + ["__version__"])