Skip to main content

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

Project description

citation-url

Tests Cookiecutter template from @cthoyt PyPI PyPI - Python Version PyPI - License Code style: black

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 CURIE pair (with None as the first entry if it could not parse)

>>> import citation_url

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

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

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

🕵️ Why?

I wanted to be able to curate a list of papers in Zotero, make an XML export, extract and normalize the messy contents in the text-url and pdf-url fields, then ensure that there are appropriate entries on Wikidata by using the Su Lab's Wikidata Integrator.

Reuse this functionality with:

$ python -m citation_url.zotero --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

See developer instrutions

The final section of the README is for if you want to get involved by making a code contribution.

Development Installation

To install in development mode, use the following:

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

🥼 Testing

After cloning the repository and installing tox with pip install tox, the unit tests in the tests/ folder can be run reproducibly with:

$ tox

Additionally, these tests are automatically re-run with each commit in a GitHub Action.

📖 Building the Documentation

$ tox -e docs

📦 Making a Release

After installing the package in development mode and installing tox with pip install tox, the commands for making a new release are contained within the finish environment in tox.ini. Run the following from the shell:

$ tox -e finish

This script does the following:

  1. Uses Bump2Version to switch the version number in the setup.cfg and src/citation_url/version.py to not have the -dev suffix
  2. Packages the code in both a tar archive and a wheel
  3. Uploads to PyPI using twine. Be sure to have a .pypirc file configured to avoid the need for manual input at this step
  4. Push to GitHub. You'll need to make a release going with the commit where the version was bumped.
  5. Bump the version to the next patch. If you made big changes and want to bump the version by minor, you can use tox -e bumpversion minor after.

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

citation_url-0.1.0.tar.gz (16.0 kB view details)

Uploaded Source

Built Distribution

citation_url-0.1.0-py3-none-any.whl (9.2 kB view details)

Uploaded Python 3

File details

Details for the file citation_url-0.1.0.tar.gz.

File metadata

  • Download URL: citation_url-0.1.0.tar.gz
  • Upload date:
  • Size: 16.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.1

File hashes

Hashes for citation_url-0.1.0.tar.gz
Algorithm Hash digest
SHA256 2b0c38fba4dfb7f7714cca6d309698370fb9be415922fda34d6dd7c2d61add16
MD5 f70d4c3789a0fef9ad68733e1ee30f8c
BLAKE2b-256 a21ee7682433581e9bf8607b659b54648e4dfd3d33fc6ae99cca34d6032906fc

See more details on using hashes here.

Provenance

File details

Details for the file citation_url-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: citation_url-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 9.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.8.0 pkginfo/1.8.2 readme-renderer/32.0 requests/2.27.1 requests-toolbelt/0.9.1 urllib3/1.26.8 tqdm/4.62.3 importlib-metadata/4.11.0 keyring/23.5.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.10.1

File hashes

Hashes for citation_url-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 136229a5d416e6aa979aeaedcd18d9be1204210a2b28e7dd0a682594c3192a8c
MD5 561447f8b9922a03a2644dbd7edf0534
BLAKE2b-256 c6d65298f00d370e0480844c9ed92e1f49ac4ca735575243264da9a63ccc73d0

See more details on using hashes here.

Provenance

Supported by

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