Getting Started
User Guide
API Reference
Block
Block.id
Block.page
Block.bbox
Block.text
Block.category
Block.confidence
Block.__init__()
HighlightResult
HighlightResult.input_path
HighlightResult.output_path
HighlightResult.blocks
HighlightResult.pages
HighlightResult.annotations_added
HighlightResult.counts()
HighlightResult.__init__()
apply_classifications()
extract_blocks()
highlight_pdf()
save_with_highlights()
_split_sentences()
classify_llm()
classify_stub()
_line_quads_in_rect()
_search_quads_for_sentence()
apply_highlights()
_corner_rect()
_draw_legend_overlay()
add_legend()
add_legend_page()
add_legend_footer()
run_tool()
Paper
Paper.model_dump()
Paper.from_dict()
Paper.to_dict()
Paper.detect_open_access()
Paper.is_open_access
Papers
Papers.__init__()
Papers.__len__()
Papers.__iter__()
Papers.__getitem__()
Papers.__repr__()
Papers.__str__()
Papers.__dir__()
Papers.papers
Papers.append()
Papers.extend()
Papers.to_list()
Papers.filter()
Papers.sort_by()
Papers.from_bibtex()
Papers._from_bibtex_file()
Papers._from_bibtex_text()
Papers._bibtex_entry_to_paper()
Papers.save()
Papers.to_dict()
Papers.to_dataframe()
Papers.summary()
Scholar
Scholar.name
Scholar.__init__()
OAStatus
OAStatus.GOLD
OAStatus.GREEN
OAStatus.HYBRID
OAStatus.BRONZE
OAStatus.CLOSED
OAStatus.UNKNOWN
OAResult
OAResult.is_open_access
OAResult.status
OAResult.oa_url
OAResult.source
OAResult.license
OAResult.confidence
OAResult.__init__()
detect_oa_from_identifiers()
check_oa_status()
check_oa_status_async()
is_open_access_source()
is_open_access_journal()
is_arxiv_id()
OASourcesCache
OASourcesCache.__init__()
OASourcesCache.get_instance()
OASourcesCache._is_cache_valid()
OASourcesCache._load_from_cache()
OASourcesCache._save_to_cache()
OASourcesCache._fetch_oa_sources_async()
OASourcesCache._fetch_oa_sources_sync()
OASourcesCache.ensure_loaded()
OASourcesCache.is_oa_source()
OASourcesCache.is_oa_issn()
OASourcesCache.source_count
OASourcesCache.cache_age_hours
get_oa_cache()
is_oa_journal_cached()
refresh_oa_cache()
JournalNormalizer
JournalNormalizer.__init__()
JournalNormalizer.get_instance()
JournalNormalizer._is_cache_valid()
JournalNormalizer._load_from_cache()
JournalNormalizer._save_to_cache()
JournalNormalizer._add_journal()
JournalNormalizer._fetch_journals_async()
JournalNormalizer._fetch_journals_sync()
JournalNormalizer.ensure_loaded()
JournalNormalizer.get_issn_l()
JournalNormalizer.normalize()
JournalNormalizer.get_abbreviation()
JournalNormalizer.get_journal_info()
JournalNormalizer.is_same_journal()
JournalNormalizer.is_open_access()
JournalNormalizer.search()
JournalNormalizer.journal_count
JournalNormalizer.cache_age_hours
get_journal_normalizer()
normalize_journal_name()
get_journal_issn_l()
is_same_journal()
refresh_journal_cache()
ScholarAuthManager
ScholarAuthManager.__init__()
ScholarAuthManager.ensure_authenticate_async()
ScholarAuthManager.is_authenticate_async()
ScholarAuthManager.authenticate_async()
ScholarAuthManager.get_auth_headers_async()
ScholarAuthManager.get_auth_options()
ScholarAuthManager.get_auth_cookies_async()
ScholarAuthManager._register_provider()
ScholarAuthManager.set_active_provider()
ScholarAuthManager.get_active_provider()
ScholarAuthManager.logout_async()
ScholarAuthManager.list_providers()
AuthenticationGateway
AuthenticationGateway.name
AuthenticationGateway.__init__()
AuthenticationGateway.prepare_context_async()
AuthenticationGateway._resolve_publisher_url_async()
AuthenticationGateway._check_auth_requirements_from_doi()
AuthenticationGateway._check_auth_requirements()
AuthenticationGateway._establish_authentication_async()
URLContext
URLContext.doi
URLContext.title
URLContext.url
URLContext.pdf_urls
URLContext.requires_auth
URLContext.auth_provider
URLContext.auth_gateway_url
URLContext.__init__()
ScholarBrowserManager
ScholarBrowserManager.__init__()
ScholarBrowserManager.get_authenticated_browser_and_context_async()
ScholarBrowserManager._new_context_async()
ScholarBrowserManager._verify_xvfb_running()
ScholarBrowserManager._load_auth_cookies_to_persistent_context_async()
ScholarBrowserManager.take_screenshot_async()
ScholarBrowserManager.start_periodic_screenshots_async()
ScholarBrowserManager.stop_periodic_screenshots_async()
ScholarBrowserManager.close()
ScholarConfig
ScholarConfig.__init__()
ScholarConfig.__getattr__()
ScholarConfig.__dir__()
ScholarConfig.resolve()
ScholarConfig.get()
ScholarConfig.print()
ScholarConfig.clear_log()
ScholarConfig.load_yaml()
ScholarConfig.load()
ScholarConfig.paths
PublisherRules
PublisherRules.__init__()
PublisherRules.get_config_for_url()
PublisherRules.merge_with_config()
PublisherRules.is_valid_pdf_url()
PublisherRules.filter_pdf_urls()
apply_filters()
clean_text()
generate_cite_key()
paper_normalize()
paper_from_search_result()
make_citation_key()
sanitize_filename()
to_bibtex()
to_ris()
to_endnote()
to_csv_row()
to_text_citation()
clean_bibtex_for_arxiv()
papers_to_format()
CitationGraphBuilder
CitationGraphBuilder.__init__()
CitationGraphBuilder._auto_detect()
CitationGraphBuilder.build()
CitationGraphBuilder._create_paper_node()
CitationGraphBuilder._build_citation_edges()
CitationGraphBuilder.build_from_dois()
CitationGraphBuilder.build_from_query()
CitationGraphBuilder.export_json()
CitationGraphBuilder.get_paper_summary()
PaperNode
PaperNode.doi
PaperNode.title
PaperNode.year
PaperNode.authors
PaperNode.journal
PaperNode.citation_count
PaperNode.similarity_score
PaperNode.is_seed
PaperNode.metadata
PaperNode.to_dict()
PaperNode.__init__()
CitationEdge
CitationEdge.source
CitationEdge.target
CitationEdge.edge_type
CitationEdge.weight
CitationEdge.to_dict()
CitationEdge.__init__()
CitationGraph
CitationGraph.seed_doi
CitationGraph.seed_dois
CitationGraph.nodes
CitationGraph.edges
CitationGraph.metadata
CitationGraph.to_dict()
CitationGraph.node_count
CitationGraph.edge_count
CitationGraph.to_networkx()
CitationGraph.__init__()
plot_citation_graph()
list_backends()
ImpactFactorEngine
ImpactFactorEngine.__init__()
ImpactFactorEngine._get_jcr_year()
ImpactFactorEngine._get_metrics_uncached()
ImpactFactorEngine.get_database_info()
get_journal_metrics()
ScholarEngine
ScholarEngine.__init__()
ScholarEngine._setup_cache()
ScholarEngine._load_cache()
ScholarEngine._save_cache()
ScholarEngine._get_cache_key()
ScholarEngine.search_async()
ScholarEngine.search_batch_async()
ScholarEngine._search_engine_with_timeout()
ScholarEngine._extract_identifiers()
ScholarEngine._identifiers_match()
ScholarEngine._validate_paper_consistency()
ScholarEngine._validate_against_query()
ScholarEngine._combine_metadata()
ScholarEngine._merge_metadata_structures()
from_connected_papers()
to_connected_papers()
ScholarPDFDownloader
ScholarPDFDownloader.__init__()
ScholarPDFDownloader.download_from_urls()
ScholarPDFDownloader.download_open_access()
ScholarPDFDownloader.download_smart()
ScholarPDFDownloader.download_from_url()
scitex_scholar
scitex_scholar.auth
scitex_scholar.browser
scitex_scholar.citation_graph
scitex_scholar.config
scitex_scholar.core
scitex_scholar.filters
scitex_scholar.formatting
scitex_scholar.impact_factor
scitex_scholar.metadata_engines
scitex_scholar.migration
scitex_scholar.pdf_download
scitex_scholar.pdf_highlight
scitex_scholar.pdf_highlight._annotator
scitex_scholar.pdf_highlight._blocks
scitex_scholar.pdf_highlight._classifier
scitex_scholar.pdf_highlight._colors
scitex_scholar.pdf_highlight._mcp
