crossref module

class pygetpapers.repository.crossref.CrossRef

Bases: RepositoryInterface

CrossRef class which handles crossref repository. It uses habanero repository wrapper to make its query

apipaperdownload(query_namespace)

Takes in the query_namespace object as the parameter and runs the query search for given search parameters.

Parameters

query_namespace (dict) – pygetpaper’s namespace object containing the queries from argparse

crossref(query, cutoff_size, filter_dict=None, update=None, makecsv=False, makexml=False, makehtml=False)

Builds the crossref searcher and writes the xml, csv and html

Parameters
  • query (string) – query given to crossref

  • cutoff_size (int) – number of papers to retrieve

  • filter_dict (bool, optional) – filters for crossref search

  • makecsv (bool) – whether to get csv

  • makehtml (bool) – whether to get html

  • makexml (bool) – whether to get xml

  • update (dict) – dictionary containing results from previous run of pygetpapers

Returns

dictionary of results retrieved from crossref

Return type

dict

initiate_crossref()

Initate habanero wrapper for crossref

Returns

crossref object

noexecute(query_namespace)

Takes in the query_namespace object as the parameter and runs the query search for given search parameters but only prints the output and not write to disk.

Parameters

query_namespace (dict) – pygetpaper’s namespace object containing the queries from argparse

update(query_namespace)

If there is a previously existing corpus, this function reads in the ‘cursor mark’ from the previous run, increments in, and adds new papers for the given parameters to the existing corpus.

Parameters

query_namespace (dict) – pygetpaper’s namespace object containing the queries from argparse