https://github.com/braun-steven/arxiv-downloader

A command line interface to download PDF files from https://arxiv.org.
https://github.com/braun-steven/arxiv-downloader

Last synced: 4 days ago
JSON representation

A command line interface to download PDF files from https://arxiv.org.

• Host: GitHub
• URL: https://github.com/braun-steven/arxiv-downloader
• Owner: braun-steven
• License: mit
• Created: 2021-06-28T08:09:32.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-04-11T13:53:45.000Z (about 1 year ago)
• Last Synced: 2025-04-22T21:04:39.109Z (11 days ago)
• Language: Python
• Size: 382 KB
• Stars: 50
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# arxiv-downloader: The arXiv PDF Command-Line Interface Downloader

![](https://img.shields.io/pypi/v/arxiv-downloader)

![Python Version](https://img.shields.io/badge/python-3.9%20|%203.10%20|%203.11%20|%203.12-blue)

![License](https://img.shields.io/badge/license-MIT-blue)

![AUR](https://img.shields.io/aur/version/arxiv-downloader)

![](./featured.svg)

## Installation

`arxiv-downloader` is available via PyPi:

``` sh

pip install arxiv-downloader

```

### Arch User Repository

We also provide an AUR package:

``` sh

paru -S arxiv-downloader

```

## Examples

Download a PDF using a URL:

``` sh

arxiv-downloader https://arxiv.org/pdf/2302.06544.pdf

```

Download a PDF using an ID:

``` sh

arxiv-downloader 2302.06544

```

Download a PDF into a directory:

``` sh

arxiv-downloader https://arxiv.org/pdf/2302.06544.pdf -d ./pdfs

```

Download a PDF and its source files (as `.tar.gz` archive):

``` sh

arxiv-downloader https://arxiv.org/pdf/2302.06544.pdf -s

```

## Usage

To see all available options, use the help command:

``` sh

arxiv-downloader -h

```

This will display usage information similar to the following:

```plaintext

usage: arxiv-downloader [-h] [-d DIRECTORY] [-s] [url_or_id]

Download articles from arXiv.

positional arguments:

  url_or_id             The URL or ID of the arXiv article. (default: None)

options:

  -h, --help            show this help message and exit

  -d DIRECTORY, --directory DIRECTORY

                        The directory where the article will be downloaded. (default: ./)

  -s, --source          Also download the source files of the article. (default: False)

```