modules.api.ArxivApi

class documentation

class ArxivApi: (source)

Constructor: ArxivApi(keyword, start, max_results)

View In Hierarchy

Undocumented

Method __init__ Initializes an ArxivApi object.
Method create_query_string Creates the query string for the ArXiv API request.
Method get_data Retrieves the data from the ArXiv API.
Method set_documents Sets the documents based on the retrieved data.
Instance Variable base_url Undocumented
Instance Variable data Undocumented
Instance Variable keyword Undocumented
Instance Variable max_results Undocumented
Instance Variable query_params Undocumented
Instance Variable session Undocumented
Instance Variable start Undocumented
Instance Variable url Undocumented
def __init__(self, keyword: str, start: int = 0, max_results: int = 1): (source)

Initializes an ArxivApi object.

This method is responsible for creating a new instance of the ArxivApi class.

Args:

    keyword (str): The keyword to search for.
    start (int): The starting index of the search results.
    max_results (int): The maximum number of results to retrieve.
def create_query_string(self, **kwargs): (source)

Creates the query string for the ArXiv API request.

Args:

    **kwargs: The keyword arguments to update the query Args:.
def get_data(self) -> dict|None: (source)

Retrieves the data from the ArXiv API. Returns: dict | None: The parsed data from the API response, or None if the request failed.

def set_documents(self) -> list: (source)

Sets the documents based on the retrieved data. Returns: list: A list of Document objects.

base_url: str = (source)

Undocumented

data = (source)

Undocumented

keyword = (source)

Undocumented

max_results = (source)

Undocumented

query_params = (source)

Undocumented

session = (source)

Undocumented

start = (source)

Undocumented

url = (source)

Undocumented