Skip to main content

Python Client Library and CLI client for the ArXiv.org API

Project description

See source on GitHub: https://github.com/culshoefer/pyarxiv

buildstatusCoverage Status

pyarxiv

pyarxiv is a wrapper for the API of Cornell University’s famous repository for scientific papers.

Supports Python 2.7, 3.3-3.6+

Installation

pip install pyarxiv

Features

  • Query the arXiv API (atom feed) in your code
  • Use enums for arXiv categories
  • Download papers in your code as PDF TODO - Do the above in the commandline

Usage

CLI

pyarxiv-cli download -h
pyarxiv-cli query -h
# will download a couple of papers with given ids to folder /home/user, name them according to their titles,
# append their arxiv ids, and do not give progress feedback when each paper is downloaded
pyarxiv-cli download 1703.00001 1703.00002v1 ... --target-folder=/home/user --use-title-for-filename --append-id --silent
# Queries for papers with "Lorem" in them, maximally gets 5 papers (default 100), authors Einstein and Zweistein
# Other potential arguments are --abstract, --journalref and manualmode with --querystring
pyarxiv-cli query --title="Lorem" --max-results=5 --authors="A Einstein, B Zweistein"

You can also chain commands:

pyarxiv-cli download $(pyarxiv-cli query --title="WaveNet") --use-title-for-filename --append-id

Python

from pyarxiv import query, download_entries
from pyarxiv.arxiv_categories import ArxivCategory, arxiv_category_map
#query(max_results=100, ids=[], categories=[],
#                title='', authors='', abstract='', journal_ref='',
#                querystring='')
entries = query(title='WaveNet')
titles = map(lambda x: x['title'], entries)
print(list(titles))


#download_entries(entries_or_ids_or_uris=[], target_folder='.',
#                     use_title_for_filename=False, append_id=False,
#                     progress_callback=(lambda x, y: id))
download_entries(entries)


entries_with_category = query([ArxivCategory.cs_AI])
print(arxiv_category_map(ArxivCategory.cs_AI))

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for pyarxiv, version 1.0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size pyarxiv-1.0.3.1.tar.gz (11.0 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page