paper-title

Get a formatted pdf filename for a paper specified by a DOI.

Usage

Title for .pdf file

$ papertitle https://doi.org/10.1038/nature05116

Drake_2006_Electron_Acceleration_From_Contracting_Magnetic_Islands_During_Reconnection.pdf

The format is: AuthorSurname_Year_Title_Of_Paper.pdf

Short citation

$ papercitation https://doi.org/10.1038/nature05116

Drake et al - 2006 - Electron acceleration from contracting magnetic islands during reconnection

Full APA style formatted citation

$ paperformatted https://doi.org/10.1038/nature05116

Drake, J. F., Swisdak, M., Che, H., & Shay, M. A. (2006). Electron acceleration from contracting magnetic islands during reconnection. Nature, 443(7111), 553–556. https://doi.org/10.1038/nature05116

Requirements

• python>=3.10
• typer>=0.9
• requests>=2.30
• pytest>=7.3

Installation

$ git clone git@github.com:jmsplank/paper-title.git
$ cd paper_titles
$ pip install .

Testing

This project usses pytest to test the code.

$ pytest

To get a coverage report, use:

pytest --cov-report=html --cov

This generates coverage html, view it by opening ./htmlcov/index.html.