Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

unofficial API tool for arxiv.org scientific publications

Project Description

arxiver is an unoffical API for Cornell’s arxiv.org. This package allows access for search results and new publications in various topics.

Getting started

Install arxiver by running the following command:

$ pip install arxiver

And then in your Python file add:

import arxiver

There are two main arxiver functions: get_new_publ and search.

get_new_publ(topic)

Returns all new publications posted on arxiv.org given a certain topic in a Paper list.

Parameters

topic: string that identifies from which topic the new publications should be retrieved. List of valid topics:

'astro-ph'      # Astrophysics
'cond-mat'      # Condensed Matter
'gr-qc'         # General Relativity and Quantum Cosmology
'hep-ex'        # High Energy Physics - Experiment
'hep-lat'       # High Energy Physics - Lattice
'hep-ph'        # High Energy Physics - Phenomenology
'hep-th'        # High Energy Physics - Theory
'math-ph'       # Mathematical Physics
'nlin'          # Nonlinear Sciences
'nucl-ex'       # Nuclear Experiment
'nucl-th'       # Nuclear Theory
'physics'       # Physics
'quant-ph'      # Quantum Physics

'math'          # Mathematics

'cs'            # Computer Science

'q-bio'         # Quantitative Biology
'q-fin'         # Quantitative Finance
'stat'          # Statistics

Example

Return of list of papers from new publications in Computer Science and print out the link to each pdf:

papers = arxiver.get_new_publ('cs')
for paper in papers:
    print paper.pdf

search(query, max_results=30)

Return list of Paper objects from arxiv given a search query and a maximum number of results.

Parameters

query: string search query to pass to arxiv.org

max_results: optional positive integer maxiumum number of results to be returned (default is 30)

Example

Return a list of fifteen papers given ‘electron’ as a search term and print the abstract of each one:

papers = arxiver.search('electron', max_results=15)
for paper in paper:
    print paper.abstract

Paper

Paper objects have the following properties:

  • Paper.title the title of the paper
  • Paper.abstract the abstract or short summary
  • Paper.arxiv_id unique string that identifies the arxiv paper
  • Paper.pdf link to the pdf file of the whole paper
  • Paper.page link to the page on arxiv.org that includes more information
  • Paper.authors list of authors reprented by dictionaries with key 'name' and 'link'
Release History

Release History

This version
History Node

0.0.4

History Node

0.0.3

History Node

0.0.2

History Node

0.0.1

Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
arxiver-0.0.4.tar.gz (4.9 kB) Copy SHA256 Checksum SHA256 Source Oct 12, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting