Metadata-Version: 2.1
Name: arxiv-dl
Version: 0.0.3
Summary: Download paper from arXiv
Home-page: UNKNOWN
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 

Download paper from arXiv

## Installation 

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

## Configuration (Optional)

Default Download Destination: 

```bash
"{$HOME}/Downloads/ArXiv_Papers"
```

Set Custom Download Destination

- Let's say you want your papers get downloaded into `~/Documents/Papers`
- Make sure the directory `~/Documents/Papers` exists

```bash
export ARXIV_DOWNLOAD_FOLDER=~/Documents/Papers
```

## Usage

```bash
add-paper "URL"
```
`add-paper` will do

- Download paper `{paper_id}_{title}.pdf` into `ARXIV_DOWNLOAD_FOLDER`.
- Maintain a paper list containing metadata in json at `ARXIV_DOWNLOAD_FOLDER/000_Paper_List.json`.
- Create a new MarkDown document named `{paper_id}_Notes.md` in the same directory. (for you to add reading notes)

```bash
dl-paper "URL"
```
`dl-paper` will do

- Download paper `{paper_id}_{title}.pdf` into `ARXIV_DOWNLOAD_FOLDER`.

## Currently supported URLs

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

## License

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


