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.
Contribute on Github
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 paperPaper.abstract
the abstract or short summaryPaper.arxiv_id
unique string that identifies the arxiv paperPaper.pdf
link to the pdf file of the whole paperPaper.page
link to the page on arxiv.org that includes more informationPaper.authors
list of authors reprented by dictionaries with key'name'
and'link'
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file arxiver-0.0.4.tar.gz
.
File metadata
- Download URL: arxiver-0.0.4.tar.gz
- Upload date:
- Size: 4.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2306eb4ffaea4c3a34a1cfb59a312d2441ca17c43b518ce4d9a7dfde7559a90f |
|
MD5 | 83145e96ebe22e6be51dbc520872c098 |
|
BLAKE2b-256 | 9f23f1cc9eac2a59523cccac1bed7f53a76df1a5cda9679843d97efed3f7545e |