citation-url

Parse URLs for DOIs, PubMed identifiers, PMC identifiers, arXiv identifiers, etc.

This module has a single parse() function that takes in a URL and gives back a parse status (success, unknown, or irreconcilable), a prefix, and an identifier. If the status is unknown or irreconcilable, the prefix will be left as None and the identifier will match the input:

>>> from citation_url import parse, Status

>>> parse("https://joss.theoj.org/papers/10.21105/joss.01708")
(Status.success, 'doi', '10.21105/joss.01708')

>>> parse("http://www.ncbi.nlm.nih.gov/pubmed/34739845")
(Status.success, 'pubmed', '34739845')

>>> parse("https://example.com/true-garbage")
(Status.unknown, None, 'https://example.com/true-garbage')

>>> parse("https://example.com/true-garbage")
(Status.unknown, None, 'https://example.com/true-garbage')

>>> parse("http://msb.embopress.org/content/13/11/954.full.pdf")
(Status.irreconcilable, None, 'http://msb.embopress.org/content/13/11/954.full.pdf')

🕵️ Why?

I wanted to be able to curate a list of papers in Zotero, Mendeley, or any other modern citation manager, make an XML export in the EndNote format, extract and normalize the messy contents in the electronic-resource-num, text-urls, and pdf-urls fields, then ensure that there are corresponding entries on Wikidata using the Su Lab's Wikidata Integrator.

Reuse this functionality with:

$ python -m citation_url.endnote --help

🚀 Installation

The most recent release can be installed from PyPI with:

$ pip install citation_url

The most recent code and data can be installed directly from GitHub with:

$ pip install git+https://github.com/cthoyt/citation-url.git

👐 Contributing

Contributions, whether filing an issue, making a pull request, or forking, are appreciated. See CONTRIBUTING.md for more information on getting involved.

👋 Attribution

⚖️ License

The code in this package is licensed under the MIT License.

🍪 Cookiecutter

This package was created with @audreyfeldroy's cookiecutter package using @cthoyt's cookiecutter-snekpack template.

🛠️ For Developers

$ git clone git+https://github.com/cthoyt/citation-url.git
$ cd citation-url
$ pip install -e .

$ tox

$ tox -e docs

$ tox -e finish