Skip to main content

Fetch BibTeX from DOI, arXiv ID, journal URL and article title

Project description

doi2bib3

doi2bib3 is a small Python utility to fetch BibTeX metadata for a DOI or to resolve arXiv identifiers to DOIs and fetch their BibTeX entries. It accepts DOI inputs, DOI URLs, arXiv IDs/URLs (modern and legacy), publisher landing pages, and uses a sequence of resolution strategies to return a BibTeX string. This tool combines the features of doi2bib and doi2bib2.

Key behaviors

  • Accepts DOI, DOI URL, arXiv ID/URL, publisher URL, or article-title text.
  • Resolves inputs to a DOI using URL metadata, arXiv metadata, Crossref lookup, and DOI content negotiation with Crossref fallback.
  • Normalizes BibTeX output, including journal abbreviation mappings and selected publisher-specific cleanup.
  • Full pipeline documentation (input -> output): docs/ALGORITHM.md
  • Diagram version of the pipeline: docs/ALGORITHM_VISUALS.md

A cross-platform GUI frontend is available: Check out QuickBib and its webapp.

Installation

Packaging status

Install from pypi

pip install --user doi2bib3

Arch Linux

In Arch Linux you can install it from the AUR with the command yay -S python-doi2bib3.

Ubuntu

You can use our official PPA

sudo add-apt-repository ppa:apandada1/quickbib
sudo apt update
sudo apt install python3-doi2bib3

Debian

You can grab the prebuild .deb package from GitHub releases.

Installing from source

Create a virtual environment and install runtime dependencies:

git clone https://github.com/archisman-panigrahi/doi2bib3.git
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

Install the package for local development:

pip install -e .

CLI usage

The CLI accepts a single positional identifier, an optional -o/--out path to save the BibTeX output, and -b/--bibitem to also print an APS/RevTeX-style \bibitem. When installed, the package installs a console script named doi2bib3 (configured in pyproject.toml). From the repository root you can run the local script wrapper at scripts/doi2bib3.

# using the local wrapper script from repo root
python scripts/doi2bib3 <identifier> [-o OUT] [--bibitem]

# or when installed as console script
doi2bib3 <identifier> [-o OUT] [--bibitem]

Examples

Fetch by DOI (bare DOI or DOI URL):

doi2bib3 10.1038/nphys1170
doi2bib3 https://doi.org/10.1038/nphys1170

ArXiv inputs (detected automatically):

doi2bib3 https://arxiv.org/abs/2411.08091
doi2bib3 arxiv.org/abs/2411.08091
doi2bib3 www.arxiv.org/abs/2411.08091
doi2bib3 arXiv:2411.08091
doi2bib3 2411.08091
doi2bib3 hep-th/9901001

Name of the paper (includes fuzzy search):

doi2bib3 "Projected Topological Branes"

Publisher/article pages (Supports APS, AMS, ACS, Science, IOP Science, Nature, PNAS, SciPost, and ScienceDirect journals):

doi2bib3 https://www.pnas.org/doi/10.1073/pnas.2305943120
doi2bib3 https://iopscience.iop.org/article/10.1088/1402-4896/ad995f/pdf
doi2bib3 https://www.scipost.org/SciPostPhys.20.3.082/
doi2bib3 https://www.scipost.org/SciPostPhys.20.3.082/pdf
doi2bib3 https://www.sciencedirect.com/science/article/pii/S0003491605000096?via%3Dihub

Save to a file:

doi2bib3 https://doi.org/10.1038/nphys1170 -o paper.bib

This appends the BibTeX entry to paper.bib and prints Wrote paper.bib.

Print BibTeX and an APS/RevTeX-style \bibitem without saving to a file:

doi2bib3 https://doi.org/10.1038/nphys1170 --bibitem

Save BibTeX to a file and print the \bibitem:

doi2bib3 https://doi.org/10.1038/nphys1170 -o paper.bib --bibitem

When -o/--out and --bibitem are used together, the BibTeX entry is appended to the file, Wrote paper.bib is printed, and the \bibitem is printed to the terminal. The \bibitem is not written to the .bib file.

Note: If the tool is not installed, you can run python scripts/doi2bib3 https://doi.org/10.1038/nphys1170.

Supported journal groups

doi2bib3 directly supports many APS, AMS, ACS, Nature, PNAS, SciPost, ScienceDirect and IOP groups of journals. For other journals, the DOI link works, but the paper's URL would not work..

Programmatic usage

Public API

The Python API exposes one primary function:

  • doi2bib3.fetch_bibtex(identifier: str, timeout: int = 15) -> str

Example:

from doi2bib3 import fetch_bibtex

bib = fetch_bibtex('https://www.pnas.org/doi/10.1073/pnas.2305943120')
print(bib)

Additionally two convenience helpers are provided for APS/RevTeX-style \bibitem output:

  • doi2bib3.format_bibtex_to_aps_bibitem(bibtex_str: str, key: Optional[str] = None) -> str
  • doi2bib3.fetch_bibitem_aps(identifier: str, key: Optional[str] = None, timeout: int = 15) -> str

Examples:

Format an already-obtained BibTeX string into an APS \bibitem:

from doi2bib3 import format_bibtex_to_aps_bibitem

normalized_bibtex = "@article{smith_foobar_2020, title={Foo Bar}, author={Smith, A.}, year={2020}}"
bibitem = format_bibtex_to_aps_bibitem(normalized_bibtex, key="Smith2020")
print(bibitem)

Fetch an identifier (DOI/arXiv/etc.), get its normalized BibTeX, and return an APS \bibitem in one call:

from doi2bib3 import fetch_bibitem_aps

bibitem = fetch_bibitem_aps('10.1038/nphys1170', key='PhysRevSmith2008')
print(bibitem)

Programmatic CLI entry

Use subprocess with scripts/doi2bib3 (or installed doi2bib3 command) for automated CLI tests.

Internal module layout

  • doi2bib3/backend.py: input resolution and network fetch logic
  • doi2bib3/normalize.py: BibTeX normalization/transforms
  • doi2bib3/io.py: file output helpers
  • scripts/doi2bib3: command-line argument parsing and output handling

License

This project is distributed under the GNU General Public License v3 (GPL-3.0-only).

Acknowledgements

Parts of the code and documentation were assisted by copilot and codex.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

doi2bib3-1.3.1.tar.gz (36.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

doi2bib3-1.3.1-py3-none-any.whl (31.2 kB view details)

Uploaded Python 3

File details

Details for the file doi2bib3-1.3.1.tar.gz.

File metadata

  • Download URL: doi2bib3-1.3.1.tar.gz
  • Upload date:
  • Size: 36.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for doi2bib3-1.3.1.tar.gz
Algorithm Hash digest
SHA256 75cbed50c13de60add3b45403b5b6a347b51539af63c3aa4a6cb856fba3bc69a
MD5 5a6a179c184c6db6c70aabb25b2a6b50
BLAKE2b-256 b658b166bc6d2e76e7d80314b37d80a74b2d29f7eec6866f5280cfb55fcca8d6

See more details on using hashes here.

File details

Details for the file doi2bib3-1.3.1-py3-none-any.whl.

File metadata

  • Download URL: doi2bib3-1.3.1-py3-none-any.whl
  • Upload date:
  • Size: 31.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.5

File hashes

Hashes for doi2bib3-1.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 c4f6d2afbed8967497987aa5144bac3381cae17a05d63c0c77122320fc442115
MD5 cb36d8740256c87acd87f0978f129553
BLAKE2b-256 ca1be615ab5d6751286575d3fb172d60f7a4d760a62d0b0de39dc7329b1f956a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page