Metadata-Version: 2.1
Name: arxiv-dl
Version: 0.1.0
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: Programming Language :: Python :: 3.9
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

-   Powered by [arXiv API](https://arxiv.org/help/api/user-manual) and [Papers with code](https://paperswithcode.com/)
-   [Source Code](https://github.com/MarkHershey/arxiv-dl)
-   [Python Package Index (PyPI)](https://pypi.org/project/arxiv-dl/)

## Features

This is a command-line tool, you just need to use `Python3`'s `pip` to install the package, then, you will be able to use the following commands in your shell/terminal.

### 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`, `code`, 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.

## Usage

To install the commands

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

To use the commands in your shell/terminal

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

# OR

$ dl-paper "URL or ID"
```

Usage Example:

```bash
$ add-paper 1512.03385

# OR
$ add-paper https://arxiv.org/abs/1512.03385

# OR
$ add-paper https://arxiv.org/pdf/1512.03385.pdf
```

## Configuration (Optional)

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`.

## License

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


