scholar_flux
- scholar_flux package
- Subpackages
- scholar_flux.api package
- Subpackages
- Submodules
- scholar_flux.api.base_api module
- scholar_flux.api.base_coordinator module
- scholar_flux.api.multisearch_coordinator module
- scholar_flux.api.response_coordinator module
- scholar_flux.api.response_validator module
- scholar_flux.api.search_api module
- scholar_flux.api.search_coordinator module
- scholar_flux.api.validators module
- Module contents
- scholar_flux.data package
- Submodules
- scholar_flux.data.abc_processor module
- scholar_flux.data.base_extractor module
- scholar_flux.data.base_parser module
- scholar_flux.data.data_extractor module
- scholar_flux.data.data_parser module
- scholar_flux.data.data_processor module
- scholar_flux.data.normalizing_data_processor module
- scholar_flux.data.pass_through_data_processor module
- scholar_flux.data.path_data_processor module
- scholar_flux.data.recursive_data_processor module
- Module contents
- scholar_flux.data_storage package
- Submodules
- scholar_flux.data_storage.abc_storage module
- scholar_flux.data_storage.data_cache_manager module
- scholar_flux.data_storage.in_memory_storage module
- scholar_flux.data_storage.mongodb_storage module
- scholar_flux.data_storage.null_storage module
- scholar_flux.data_storage.redis_storage module
- scholar_flux.data_storage.sql_storage module
- Module contents
- scholar_flux.exceptions package
- Submodules
- scholar_flux.exceptions.api_exceptions module
- scholar_flux.exceptions.coordinator_exceptions module
- scholar_flux.exceptions.data_exceptions module
- scholar_flux.exceptions.import_exceptions module
- scholar_flux.exceptions.path_exceptions module
- scholar_flux.exceptions.storage_exceptions module
- scholar_flux.exceptions.util_exceptions module
- Module contents
- scholar_flux.package_metadata package
- scholar_flux.security package
- scholar_flux.sessions package
- scholar_flux.utils package
- Subpackages
- Submodules
- scholar_flux.utils.config_loader module
- scholar_flux.utils.encoder module
- scholar_flux.utils.helpers module
- scholar_flux.utils.initializer module
- scholar_flux.utils.json_file_utils module
- scholar_flux.utils.json_processing_utils module
- scholar_flux.utils.logger module
- scholar_flux.utils.module_utils module
- scholar_flux.utils.provider_utils module
- scholar_flux.utils.repr_utils module
- scholar_flux.utils.response_protocol module
- Module contents
- scholar_flux.api package
- Module contents
- ScholarFlux API
APIParameterConfigAPIParameterConfig.DEFAULT_CORRECT_ZERO_INDEXAPIParameterConfig.__init__()APIParameterConfig.add_parameter()APIParameterConfig.as_config()APIParameterConfig.build_parameters()APIParameterConfig.extract_parameters()APIParameterConfig.from_defaults()APIParameterConfig.get_defaults()APIParameterConfig.mapAPIParameterConfig.parameter_mapAPIParameterConfig.show_parameters()APIParameterConfig.structure()
APIParameterMapAPIParameterMap.queryAPIParameterMap.startAPIParameterMap.records_per_pageAPIParameterMap.api_key_parameterAPIParameterMap.api_key_requiredAPIParameterMap.auto_calculate_pageAPIParameterMap.zero_indexed_paginationAPIParameterMap.api_specific_parametersAPIParameterMap.from_defaults()APIParameterMap.get_defaults()APIParameterMap.model_configAPIParameterMap.set_default_api_key_parameter()APIParameterMap.validate_api_specific_parameter_mappings()
BaseAPICachedSessionManagerCachedSessionManager.DEFAULT_EXPIRE_AFTERCachedSessionManager.__init__()CachedSessionManager.backendCachedSessionManager.cache_directoryCachedSessionManager.cache_nameCachedSessionManager.cache_pathCachedSessionManager.configure_session()CachedSessionManager.default_session_backend()CachedSessionManager.expire_afterCachedSessionManager.get_cache_directory()CachedSessionManager.get_cache_name()CachedSessionManager.kwargsCachedSessionManager.serializerCachedSessionManager.validate_cached_session()CachedSessionManager.with_session()
DataCacheManagerDataCacheManager.__init__()DataCacheManager.cache_fingerprint()DataCacheManager.cache_is_valid()DataCacheManager.cache_storageDataCacheManager.clone()DataCacheManager.configDataCacheManager.default_cache_storage()DataCacheManager.delete()DataCacheManager.from_defaults()DataCacheManager.generate_fallback_cache_key()DataCacheManager.generate_response_hash()DataCacheManager.isnull()DataCacheManager.namespaceDataCacheManager.null()DataCacheManager.raise_on_errorDataCacheManager.retrieve()DataCacheManager.retrieve_from_response()DataCacheManager.structure()DataCacheManager.ttlDataCacheManager.update_cache()DataCacheManager.verify_cache()DataCacheManager.verify_connection()DataCacheManager.with_storage()
DataExtractorDataExtractor.DEFAULT_DYNAMIC_METADATA_IDENTIFIERSDataExtractor.DEFAULT_DYNAMIC_RECORD_IDENTIFIERSDataExtractor.EXTRACTION_INDEX_KEYDataExtractor.RECORD_ID_KEYDataExtractor.__init__()DataExtractor.dynamic_identification()DataExtractor.extract()DataExtractor.strip_annotations()DataExtractor.update()
DataParserDataProcessorInMemoryStorageInMemoryStorage.DEFAULT_NAMESPACEInMemoryStorage.DEFAULT_RAISE_ON_ERRORInMemoryStorage.STORAGE_TYPEInMemoryStorage.__init__()InMemoryStorage.clone()InMemoryStorage.delete()InMemoryStorage.delete_all()InMemoryStorage.is_available()InMemoryStorage.retrieve()InMemoryStorage.retrieve_all()InMemoryStorage.retrieve_keys()InMemoryStorage.structure()InMemoryStorage.update()InMemoryStorage.verify_cache()InMemoryStorage.verify_connection()
MongoDBStorageMongoDBStorage.DEFAULT_CONFIGMongoDBStorage.DEFAULT_NAMESPACEMongoDBStorage.DEFAULT_RAISE_ON_ERRORMongoDBStorage.STORAGE_TYPEMongoDBStorage.__init__()MongoDBStorage.clone()MongoDBStorage.delete()MongoDBStorage.delete_all()MongoDBStorage.get_default_config()MongoDBStorage.is_available()MongoDBStorage.ping()MongoDBStorage.retrieve()MongoDBStorage.retrieve_all()MongoDBStorage.retrieve_keys()MongoDBStorage.update()MongoDBStorage.verify_cache()MongoDBStorage.verify_connection()
MultiSearchCoordinatorMultiSearchCoordinator.DEFAULT_THREADED_REQUEST_DELAYMultiSearchCoordinator.__init__()MultiSearchCoordinator.add()MultiSearchCoordinator.add_coordinators()MultiSearchCoordinator.coordinatorsMultiSearchCoordinator.current_providers()MultiSearchCoordinator.from_coordinators()MultiSearchCoordinator.group_by_provider()MultiSearchCoordinator.iter_pages()MultiSearchCoordinator.iter_pages_threaded()MultiSearchCoordinator.search()MultiSearchCoordinator.search_page()MultiSearchCoordinator.search_pages()MultiSearchCoordinator.search_records()MultiSearchCoordinator.select()MultiSearchCoordinator.structure()
NullStorageNullStorage.DEFAULT_NAMESPACENullStorage.DEFAULT_RAISE_ON_ERRORNullStorage.STORAGE_TYPENullStorage.__init__()NullStorage.clone()NullStorage.delete()NullStorage.delete_all()NullStorage.is_available()NullStorage.retrieve()NullStorage.retrieve_all()NullStorage.retrieve_keys()NullStorage.update()NullStorage.verify_cache()NullStorage.verify_connection()
PassThroughDataProcessorPathDataProcessorProviderConfigProviderConfig.api_key_env_varProviderConfig.api_key_requiredProviderConfig.base_urlProviderConfig.display_nameProviderConfig.docs_urlProviderConfig.field_mapProviderConfig.mapProviderConfig.metadata_mapProviderConfig.model_configProviderConfig.normalize_provider_name()ProviderConfig.parameter_mapProviderConfig.prepare_fields()ProviderConfig.provider_nameProviderConfig.records_per_pageProviderConfig.request_delayProviderConfig.search_config_defaults()ProviderConfig.structure()ProviderConfig.validate_base_url()ProviderConfig.validate_docs_url()
RecursiveDataProcessorRedisStorageRedisStorage.DEFAULT_CONFIGRedisStorage.DEFAULT_NAMESPACERedisStorage.DEFAULT_RAISE_ON_ERRORRedisStorage.STORAGE_TYPERedisStorage.__init__()RedisStorage.clone()RedisStorage.delete()RedisStorage.delete_all()RedisStorage.get_default_config()RedisStorage.is_available()RedisStorage.ping()RedisStorage.retrieve()RedisStorage.retrieve_all()RedisStorage.retrieve_keys()RedisStorage.update()RedisStorage.verify_cache()RedisStorage.verify_connection()
ResponseCoordinatorResponseCoordinator.DEFAULT_VALIDATE_FINGERPRINTResponseCoordinator.__init__()ResponseCoordinator.build()ResponseCoordinator.cacheResponseCoordinator.cache_managerResponseCoordinator.configure_cache()ResponseCoordinator.extractorResponseCoordinator.handle_response()ResponseCoordinator.handle_response_data()ResponseCoordinator.parserResponseCoordinator.processorResponseCoordinator.schema_fingerprint()ResponseCoordinator.structure()ResponseCoordinator.summary()ResponseCoordinator.update()
ResponseValidatorResponseValidator.identify_invalid_fields()ResponseValidator.identify_invalid_keywords()ResponseValidator.is_valid_content()ResponseValidator.is_valid_headers()ResponseValidator.is_valid_reason()ResponseValidator.is_valid_response_structure()ResponseValidator.is_valid_status_code()ResponseValidator.is_valid_url()ResponseValidator.structure()ResponseValidator.validate_content()ResponseValidator.validate_response()ResponseValidator.validate_response_like()ResponseValidator.validate_response_structure()
SQLAlchemyStorageSQLAlchemyStorage.DEFAULT_CONFIGSQLAlchemyStorage.DEFAULT_NAMESPACESQLAlchemyStorage.DEFAULT_RAISE_ON_ERRORSQLAlchemyStorage.STORAGE_TYPESQLAlchemyStorage.__init__()SQLAlchemyStorage.clone()SQLAlchemyStorage.create_default_url()SQLAlchemyStorage.delete()SQLAlchemyStorage.delete_all()SQLAlchemyStorage.get_default_config()SQLAlchemyStorage.get_default_url()SQLAlchemyStorage.is_available()SQLAlchemyStorage.ping()SQLAlchemyStorage.retrieve()SQLAlchemyStorage.retrieve_all()SQLAlchemyStorage.retrieve_keys()SQLAlchemyStorage.update()SQLAlchemyStorage.verify_cache()SQLAlchemyStorage.verify_connection()SQLAlchemyStorage.verify_url_string()
SearchAPISearchAPI.DEFAULT_URLSearchAPI.__init__()SearchAPI.api_keySearchAPI.api_specific_parametersSearchAPI.base_urlSearchAPI.build_parameters()SearchAPI.configSearchAPI.describe()SearchAPI.display_nameSearchAPI.from_defaults()SearchAPI.from_provider_config()SearchAPI.from_settings()SearchAPI.get_default_provider_name()SearchAPI.make_request()SearchAPI.parameter_configSearchAPI.prepare_request()SearchAPI.prepare_search()SearchAPI.provider_nameSearchAPI.querySearchAPI.rate_limiterSearchAPI.records_per_pageSearchAPI.request_delaySearchAPI.search()SearchAPI.structure()SearchAPI.summary()SearchAPI.update()SearchAPI.with_config()SearchAPI.with_config_parameters()
SearchAPIConfigSearchAPIConfig.provider_nameSearchAPIConfig.base_urlSearchAPIConfig.records_per_pageSearchAPIConfig.request_delaySearchAPIConfig.api_keySearchAPIConfig.api_specific_parametersSearchAPIConfig.DEFAULT_PROVIDERSearchAPIConfig.DEFAULT_RECORDS_PER_PAGESearchAPIConfig.DEFAULT_REQUEST_DELAYSearchAPIConfig.MAX_API_KEY_LENGTHSearchAPIConfig.api_keySearchAPIConfig.api_specific_parametersSearchAPIConfig.base_urlSearchAPIConfig.default_request_delay()SearchAPIConfig.from_defaults()SearchAPIConfig.model_configSearchAPIConfig.provider_nameSearchAPIConfig.records_per_pageSearchAPIConfig.request_delaySearchAPIConfig.set_records_per_page()SearchAPIConfig.structure()SearchAPIConfig.update()SearchAPIConfig.url_basenameSearchAPIConfig.validate_api_key()SearchAPIConfig.validate_provider_name()SearchAPIConfig.validate_request_delay()SearchAPIConfig.validate_search_api_config_parameters()SearchAPIConfig.validate_url()SearchAPIConfig.validate_url_type()
SearchCoordinatorSearchCoordinator.__init__()SearchCoordinator.as_coordinator()SearchCoordinator.fetch()SearchCoordinator.get_cached_request()SearchCoordinator.get_cached_response()SearchCoordinator.get_cached_response_keys()SearchCoordinator.get_cached_search_result()SearchCoordinator.iter_pages()SearchCoordinator.parameter_search()SearchCoordinator.robust_request()SearchCoordinator.search()SearchCoordinator.search_data()SearchCoordinator.search_page()SearchCoordinator.search_pages()SearchCoordinator.search_records()SearchCoordinator.update()
SessionManagerlog_level_context()
- Subpackages