|
| 1 | +<p align="center"> |
| 2 | + <a href="https://bibexpy.com"> |
| 3 | + <img src="apps/web/public/images/bibexpy-logo-full.png" alt="BibexPy — V2.0.0 Helium — Bibliometrics Experience with Python" width="420"> |
| 4 | + </a> |
| 5 | +</p> |
| 6 | + |
| 7 | +<p align="center"> |
| 8 | + <strong>Self-hosted, reproducible bibliometric data preparation for Web of Science & Scopus.</strong> |
| 9 | +</p> |
| 10 | + |
| 11 | +<p align="center"> |
| 12 | + <a href="https://pypi.org/project/bibexpy/"><img src="https://img.shields.io/pypi/v/bibexpy?color=0c2847&label=PyPI" alt="PyPI"></a> |
| 13 | + <a href="https://pypi.org/project/bibexpy/"><img src="https://img.shields.io/pypi/pyversions/bibexpy?color=0c2847" alt="Python"></a> |
| 14 | + <a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPL--3.0-4f1964.svg" alt="License: GPL-3.0"></a> |
| 15 | + <a href="https://doi.org/10.1016/j.softx.2025.102098"><img src="https://img.shields.io/badge/DOI-10.1016%2Fj.softx.2025.102098-0f766e" alt="DOI"></a> |
| 16 | +</p> |
| 17 | + |
| 18 | +<p align="center"> |
| 19 | + 🌐 <a href="https://bibexpy.com">bibexpy.com</a> · |
| 20 | + 📚 <a href="https://bibexpy.com/doc">Documentation</a> · |
| 21 | + 📄 <a href="https://doi.org/10.1016/j.softx.2025.102098">Paper (SoftwareX)</a> · |
| 22 | + ▶️ <a href="https://www.youtube.com/@BibexPy">YouTube</a> |
| 23 | +</p> |
| 24 | + |
| 25 | +--- |
| 26 | + |
| 27 | +**BibexPy v2.0.0 “Helium”** — the successor to v1.1.0 “Hydrogen” — turns the original |
| 28 | +command-line BibexPy into a **local web platform**, shipped as a single pip-installable |
| 29 | +package. It merges, filters, harmonizes, enriches and exports Web of Science + Scopus |
| 30 | +records with full provenance, and **never sends your licensed exports off your machine**. |
| 31 | + |
| 32 | +<p align="center"> |
| 33 | + <img src=".github/assets/bibexpy-home.png" alt="BibexPy v2 home screen" width="780"> |
| 34 | +</p> |
| 35 | + |
| 36 | +## Install |
| 37 | + |
| 38 | +```bash |
| 39 | +pip install bibexpy |
| 40 | +bibexpy # launches the local web UI (browser opens automatically) |
| 41 | +``` |
| 42 | + |
| 43 | +Requires only **Python 3.10+** — no Node.js/npm needed (the Next.js UI ships precompiled |
| 44 | +inside the wheel). Works on Windows, macOS and Linux. |
| 45 | + |
| 46 | +```bash |
| 47 | +bibexpy --port 8080 # custom port |
| 48 | +bibexpy --no-browser # server only |
| 49 | +bibexpy --storage ./data # custom storage folder |
| 50 | +bibexpy --version # → BibexPy 2.0.0 (Helium) |
| 51 | +``` |
| 52 | + |
| 53 | +Projects/data live under `~/.bibexpy/storage`; settings and API keys under `~/.bibexpy/.env` |
| 54 | +(managed from the in-app Settings page). |
| 55 | + |
| 56 | +## What's new in v2 |
| 57 | + |
| 58 | +- **One-click Smart Merge** — multi-stage probabilistic record linkage: exact DOI/identifier |
| 59 | + matching + Jaro–Winkler title similarity, confidence scoring, and an optional |
| 60 | + borderline-review queue. The result includes a copy-ready methodology paragraph. |
| 61 | +- **ORCID-first author disambiguation** — ORCID identifiers as deterministic evidence, with a |
| 62 | + constrained field-similarity fallback only when coverage is incomplete. |
| 63 | +- **Address harmonization** — organization roll-up to a canonical parent institution + |
| 64 | + country standardization. |
| 65 | +- **Multi-source enrichment** — fetch-once-fill-all across CrossRef, OpenAlex, Scopus, |
| 66 | + DataCite, Unpaywall, Europe PMC and Semantic Scholar; reverse-DOI recovery; identity |
| 67 | + fields (ORCID/ROR). Verifiable sources only — no ML-inferred metadata. |
| 68 | +- **Reproducible filtering** — multi-facet inclusion/exclusion criteria, saved as reusable |
| 69 | + presets. |
| 70 | +- **Quality dashboard** — a bibliometrically weighted health score + an exportable General |
| 71 | + Overview table (CSV / XLSX / PNG). |
| 72 | +- **Provenance** — append-only audit log, pre-operation snapshots, isolated analyses, and an |
| 73 | + auto-generated methodology narrative for your paper's data-preparation section. |
| 74 | +- **Structured export** — WoS plain text, VOSviewer TSV, BibTeX, RIS, CSV, TSV, XLSX |
| 75 | + (interoperable with VOSviewer & Biblioshiny). |
| 76 | + |
| 77 | +## Workflow |
| 78 | + |
| 79 | +A guided five-step pipeline: |
| 80 | + |
| 81 | +**Data & Merge → Records & Filtering → Harmonization → Export → Report** |
| 82 | + |
| 83 | +Raw Scopus (`.csv`) and Web of Science (`.txt`) exports are uploaded and merged in a single |
| 84 | +click (file preparation runs implicitly), and each merge is stored as an isolated, |
| 85 | +reproducible analysis. |
| 86 | + |
| 87 | +## Repository layout |
| 88 | + |
| 89 | +``` |
| 90 | +apps/ |
| 91 | + web/ # Next.js 14 frontend (static-exported into the wheel) |
| 92 | + api/ # FastAPI backend (documented HTTP API under /api) |
| 93 | +packages/ |
| 94 | + bibex_core/ # core bibliometric library (converters, merge, C1 utils, …) |
| 95 | +python_pkg/ # PyPI packaging — builds the single pip wheel |
| 96 | +scripts/ # build_wheel.sh / build_wheel.ps1 |
| 97 | +.github/workflows/ # release.yml — tag → wheel → PyPI (Trusted Publishing) |
| 98 | +``` |
| 99 | + |
| 100 | +The published wheel bundles the **prebuilt** frontend (`_web`) + backend (`_server`) + |
| 101 | +vendored core, so end users need no Node.js. Those build-time copies are git-ignored — the |
| 102 | +source of truth is `apps/` and `packages/`, and the wheel is regenerated by CI. |
| 103 | + |
| 104 | +## Development |
| 105 | + |
| 106 | +```bash |
| 107 | +# Backend (port 8001) |
| 108 | +cd apps/api |
| 109 | +pip install -r requirements.txt |
| 110 | +pip install -e ../../packages/bibex_core |
| 111 | +uvicorn main:app --reload --port 8001 |
| 112 | + |
| 113 | +# Frontend (port 3000) — separate terminal |
| 114 | +cd apps/web |
| 115 | +npm install |
| 116 | +npm run dev |
| 117 | +``` |
| 118 | + |
| 119 | +Then open <http://localhost:3000>. Run tests with `cd apps/api && python -m pytest -q`. |
| 120 | + |
| 121 | +## Build the wheel (maintainers) |
| 122 | + |
| 123 | +```bash |
| 124 | +bash scripts/build_wheel.sh # macOS / Linux |
| 125 | +pwsh scripts/build_wheel.ps1 # Windows |
| 126 | +``` |
| 127 | + |
| 128 | +→ `python_pkg/dist/bibexpy-2.0.0-py3-none-any.whl` — a pure-python `py3-none-any` wheel that |
| 129 | +installs on Windows / macOS / Linux with no compiler. |
| 130 | + |
| 131 | +## Release |
| 132 | + |
| 133 | +Tagging a version triggers GitHub Actions, which builds the wheel (with Node) and publishes |
| 134 | +it to PyPI via **Trusted Publishing (OIDC)** — no API tokens stored: |
| 135 | + |
| 136 | +```bash |
| 137 | +git tag v2.0.0 && git push origin v2.0.0 |
| 138 | +``` |
| 139 | + |
| 140 | +## Links |
| 141 | + |
| 142 | +[Website](https://bibexpy.com) · |
| 143 | +[Docs](https://bibexpy.com/doc) · |
| 144 | +[YouTube](https://www.youtube.com/@BibexPy) · |
| 145 | +[X / Twitter](https://twitter.com/BibexPy) · |
| 146 | +[Instagram](https://www.instagram.com/bibexpy/) · |
| 147 | +[Paper (SoftwareX)](https://doi.org/10.1016/j.softx.2025.102098) |
| 148 | + |
| 149 | +## License |
| 150 | + |
| 151 | +[GPL-3.0-or-later](https://www.gnu.org/licenses/gpl-3.0). |
| 152 | + |
| 153 | +## Citation |
| 154 | + |
| 155 | +If you use BibexPy in your research, please cite: |
| 156 | + |
| 157 | +> Kara, B. C., Şahin, A., & Dirsehan, T. (2025). BibexPy: Harmonizing the bibliometric |
| 158 | +> symphony of Scopus and Web of Science. *SoftwareX*, 30, 102098. |
| 159 | +> <https://doi.org/10.1016/j.softx.2025.102098> |
| 160 | +
|
| 161 | +```bibtex |
| 162 | +@article{bibexpy2025, |
| 163 | + title = {BibexPy: Harmonizing the bibliometric symphony of {Scopus} and {Web of Science}}, |
| 164 | + author = {Kara, Burak Can and {\c{S}}ahin, Alperen and Dirsehan, Ta{\c{s}}k{\i}n}, |
| 165 | + journal = {SoftwareX}, |
| 166 | + volume = {30}, |
| 167 | + pages = {102098}, |
| 168 | + year = {2025}, |
| 169 | + doi = {10.1016/j.softx.2025.102098} |
| 170 | +} |
| 171 | +``` |
0 commit comments