Package: arxiv-dl
arXiv-dlCommand-lineArXiv&CVF Open AccessPaper Downloader.[PyPI][Source]Disclaimer: This is a highly-opinionated CLI tool for downloading papers. It priorities ease of use for researchers. Obviously, this is not an official project.What does it do?Support downloading papers fromArXiv,CVPR, ICCV, WACVvia simple CLI.Support downloading speedup by usingaria2c.Retrieve the paper's metadata such as:Title, Abstract, YearAuthorsComments (Conference acceptance info)Repository URLsBibTeXCitationAutomatically maintain a list of local papers and their metadata in a JSON file.Configure the desired download destination via an environment variable or a command-line argument.All downloaded papers will have standardized filename for easy browsing.Why?Save time and effort to download and organize papers on your machine.Speedup downloading process by using multiple parallel connections.Local paper list would be handy for quick local lookup, making notes, and doing citations.How to install it?This is a command-line tool, simply usepipto install the package globally, then you are good to go!Pre-requisite:Python 3.xpython3-mpipinstall--upgradearxiv-dlNOTE: After installation, you need to ensure the installation path is included in your PATH variable. If you encounter any difficulty finding / setting the PATH, there is this recommended way ofinstalling stand alone command line tools, kindly follow its instruction when installingarxiv-dl.Optionally, installaria2cfor download speedup.MacOS:brew install aria2Linux:sudo snap install aria2cHow to use it?After installation, you may use the commandpaperin your shell to download papers. (You may also use thegetpaperorarxiv-dlcommand, they are all equivalent.)$paper[-h][-v][-p][-dDOWNLOAD_DIR][-nN_THREADS]urls[urls...]Options:-v,--verbose(optional): Print paper metadata.-p,--pdf_only(optional): Download PDF only without creating Markdown notes-d,--download_dir(optional): Specify one-time download directory. This option will override the default download directory or the one specified in the environment variableARXIV_DOWNLOAD_FOLDER.-n,--n_threads(optional): Specify the number of parallel connections to be used byaria2.Usage Examples:# Use a paper's ArXiv ID$paper1512.03385# You can download multiple papers at once$paper1512.033852103.155382304.04415# Use ArXiv URL (either abstract page or PDF page URL works!)$paperhttps://arxiv.org/abs/2103.15538# Use ArXiv URL (either abstract page or PDF page URL works!)$paperhttps://arxiv.org/pdf/1512.03385.pdf# Use CVF Open Access URL (either abstract page or PDF page URL works!)$paper"https://openaccess.thecvf.com/content/CVPR2021/html/Lin_Real-Time_High-Resolution_Background_Matting_CVPR_2021_paper.html"ConfigurationsDefault Download DestinationWithout any configurations, all paper will be downloaded to$HOME/Downloads/ArXiv_Papers.Set Your Custom Download Destination(Optional)You may configure your preferred download destination once and for all via an environment variable. This will override the default download destination. To do that, include the following line in your.bashrcor.zshrcfile:exportARXIV_DOWNLOAD_FOLDER="YOUR/PATH/TO/ANY/FOLDER"Every time you use thepapercommand, the download destination will be set to the following order of priority:Command-line option-dEnvironment variableARXIV_DOWNLOAD_FOLDERDefault download destinationSet Custom Command Alias(Optional)You can always set your own preferred alias to rename the command or add more options.Include the following line(s) in your.bashrcor.zshrcfile to set your preferred alias:aliasdp="paper"aliasdpv="paper -v -d '~/Documents/Papers'"DevelopmentSet up development environmentpython3-mvenvvenv&&\sourcevenv/bin/activate&&\pipinstall-e".[dev]"Run TestspytestBuild the packagemakeClean cache & build artifactsmakecleanTODOsAdd support for ara2c.Add support for papers on CVF Open Access.Add support for papers on OpenReview.LicenseMIT License- Copyright (c) 2021-2023 Mark Huang