Metadata-Version: 2.1
Name: arxiv-dl
Version: 0.0.4
Summary: Download paper from arXiv
Home-page: https://github.com/MarkHershey/arxiv-dl
Author: Mark Huang
Author-email: mark.h.huang@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Topic :: Utilities
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Operating System :: OS Independent
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: colorlog (>=4.1.0)
Requires-Dist: requests
Requires-Dist: beautifulsoup4

# arXiv-dl 

Command-line [arXiv.org](https://arxiv.org/) Papers Downloader

- [Source Code](https://github.com/MarkHershey/arxiv-dl)
- [Python Package Index (PyPI)](https://pypi.org/project/arxiv-dl/)

## Installation 

- Require `Python 3.x`

```bash
$ pip install --upgrade arxiv-dl
```

## Configuration 

Set Custom Download Destination Folder *(Optional)*

- Let's say you want your papers get downloaded into `~/Documents/Papers`.
- Make sure the folder `~/Documents/Papers` exists.
- Set the environment variable `ARXIV_DOWNLOAD_FOLDER` to your desired location.
    ```bash
    $ export ARXIV_DOWNLOAD_FOLDER=~/Documents/Papers
    ```
- If the environment variable is not set, paper will be downloaded into the default Download Destination `~/Downloads/ArXiv_Papers`.

## Usage

Type in command line:

```bash
$ add-paper "URL"
```

or

```bash
$ dl-paper "URL"
```

Usage Example:

```bash
$ add-paper https://arxiv.org/abs/1512.03385
```

## Features

### Commands

**`add-paper` will do**

- Download paper named `[id]_[title].pdf` into destination folder.
- Maintain a papers list named `000_Paper_List.json` in the destination folder.
- Extract paper metadata, like `title`, `authors`, `abstract`, `bibtex`, and write them into a new MarkDown document named `[id]_Notes.md` in the destination folder.

**`dl-paper` will do**

- Download paper `[id]_[title].pdf` into destination folder.

### Supported URLs

- URLs from `arXiv.org` Only
    - Paper's abstract page `https://arxiv.org/abs/xxxx.xxxxx` 
    - or Paper's PDF page `https://arxiv.org/pdf/xxxx.xxxxx.pdf`

## License

[MIT License](LICENSE) - Copyright (c) 2021 Mark Huang


