From d606b5e56ba351a739c1fd8cbced378f4a2598c1 Mon Sep 17 00:00:00 2001 From: "Phyks (Lucas Verney)" Date: Thu, 7 Jan 2016 00:54:20 +0100 Subject: [PATCH] Add a disclaimer about bulk downloadin arXiv --- libbmc/repositories/arxiv.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/libbmc/repositories/arxiv.py b/libbmc/repositories/arxiv.py index dd19511..7862be5 100644 --- a/libbmc/repositories/arxiv.py +++ b/libbmc/repositories/arxiv.py @@ -313,6 +313,11 @@ def get_sources(arxiv_id): """ Download sources on arXiv for a given preprint. + .. note:: + + Bulk download of sources from arXiv is not permitted by their API. \ + You should have a look at http://arxiv.org/help/bulk_data_s3. + :param eprint: The arXiv id (e.g. ``1401.2910`` or ``1401.2910v1``) in a \ canonical form. :returns: A ``TarFile`` object of the sources of the arXiv preprint or \ @@ -331,6 +336,11 @@ def get_bbl(arxiv_id): """ Get the .bbl files (if any) of a given preprint. + .. note:: + + Bulk download of sources from arXiv is not permitted by their API. \ + You should have a look at http://arxiv.org/help/bulk_data_s3. + :param arxiv_id: The arXiv id (e.g. ``1401.2910`` or ``1401.2910v1``) in \ a canonical form. :returns: A list of the full text of the ``.bbl`` files (if any) \ @@ -347,6 +357,11 @@ def get_citations(arxiv_id): """ Get the DOIs cited by a given preprint. + .. note:: + + Bulk download of sources from arXiv is not permitted by their API. \ + You should have a look at http://arxiv.org/help/bulk_data_s3. + :param arxiv_id: The arXiv id (e.g. ``1401.2910`` or ``1401.2910v1``) in \ a canonical form. :returns: A dict of cleaned plaintext citations and their associated DOI.