API documentation

class pygscholar.Author(*, info: AuthorInfo, publications: Sequence[Publication] = ())

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygscholar.AuthorInfo(*, name: str, scholar_id: str, link: str = '', affiliation: str = '', email: str = '', cited_by: int = 0, data: dict[str, ~typing.Any] = <factory>)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygscholar.Department(*, authors: list[Author])

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygscholar.Publication(*, title: str, year: int = 0, num_citations: int = 0, abstract: str = '', authors: str = '', journal: str = '', volume: str = '', issue: str = '', pages: str = '', publisher: str = '', pdf_url: str = '', scholar_url: str = '', date: str = '')

model_config: ClassVar[ConfigDict] = {'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

author

class pygscholar.author.Author(*, info: AuthorInfo, publications: Sequence[Publication] = ())

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class pygscholar.author.AuthorInfo(*, name: str, scholar_id: str, link: str = '', affiliation: str = '', email: str = '', cited_by: int = 0, data: dict[str, ~typing.Any] = <factory>)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

cli

Command line interface for pygscholar. You can also set the environment variable PYSCHOLAR_CACHE_DIR to change the default cache directory.

pygscholar.cli.license_callback(show_license: bool)

Prints license information.

pygscholar.cli.version_callback(show_version: bool)

Prints version information.

department

class pygscholar.department.Department(*, authors: list[Author])

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

publication

class pygscholar.publication.Publication(*, title: str, year: int = 0, num_citations: int = 0, abstract: str = '', authors: str = '', journal: str = '', volume: str = '', issue: str = '', pages: str = '', publisher: str = '', pdf_url: str = '', scholar_url: str = '', date: str = '')

model_config: ClassVar[ConfigDict] = {'frozen': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

api

class pygscholar.api.LocalNavigator(_dbname: 'Path | str | None')

class pygscholar.api.scraper.NavigatorType(*args, **kwargs)

cache

config