Skip to main content

A small command-line tool for generating a BibLaTeX file from a bunch of pdf using their DOI and Crossref.

Project description

pdf2biblatex

PyPI - Version PyPI - Python Version


pdf2biblatex is a small command-line tool for generating a BibLaTeX file from a bunch of pdf using their DOI and Crossref.

Installation

The default way of installing is by using pip :

pip install pdf2biblatex

But I recommand using pipx to not burden your system with package dependencies (pdf2biblatex requires PyMuPDF and requests), pipx putting them in a dedicated virtual environment. Installation is similar to pip :

pipx install pdf2biblatex

Otherwise, your prefered method for dealing with python package likely works.

Usage

pdf2biblatex takes a directory filled with pdf as primary input, you might need to put in a dedicated folder all those you want to use in the generation of the BibLaTeX file.

From there, typical use is :

pdf2biblatex -d path/to/directory

or

cd path/to/directory
pdf2biblatex -d

-d (or --directory) will look into the selected folder and scan the five first pages and the metadata of any pdf for a DOI. If no DOI is found or is invalid, an error indicate the associated file. Then, a BibLaTeX file is generated for all valid DOI using the Crossref API.

After this, you might want to run :

pdf2biblatex -a DOI_1 DOI_2 ...

-a (or --add-doi) will take any given DOI and generate the corresponding BibLaTeX entry in an existing BibLaTeX file or create a new one if none is detected.

Be careful if you run --directory again after using --add-doi, the former will write over the bibliography file you might have completed with the latter.

There is also a third argument -b (or --bib-file), whom you can use to change the name used for the BibLaTeX file.

For more details, you can use pdf2biblatex --help or look directly into the code at src/pdf2biblatex/pdf2biblatex.py.

License

pdf2biblatex is distributed under the terms of the GPL-3.0-or-later license.

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

pdf2biblatex-1.0.1.tar.gz (17.0 kB view details)

Uploaded Source

Built Distribution

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

pdf2biblatex-1.0.1-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file pdf2biblatex-1.0.1.tar.gz.

File metadata

  • Download URL: pdf2biblatex-1.0.1.tar.gz
  • Upload date:
  • Size: 17.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.14.3 HTTPX/0.28.1

File hashes

Hashes for pdf2biblatex-1.0.1.tar.gz
Algorithm Hash digest
SHA256 27375a0a73d0c6dc0ad126f66ab68ff55eb765e66b510f8ab77249347280a3de
MD5 953c3d6f4925fb2d7ba48b00b93b5ece
BLAKE2b-256 11ccbff8acfd65b9920b3f8d904d149803e0e6b7e796817d7b764a6d8ec605e9

See more details on using hashes here.

File details

Details for the file pdf2biblatex-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: pdf2biblatex-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Hatch/1.16.5 cpython/3.14.3 HTTPX/0.28.1

File hashes

Hashes for pdf2biblatex-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 238216a90be52e084da25146f5016d276740aa4cefa44f51fd29be78d5327a9c
MD5 a6f05f42b32fdfa9f4c87b7a2e85cc33
BLAKE2b-256 a00ddd594fe2f981600083db5f47b3d10e8ff9cef27457e8f2b7184997fac294

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