Source Code

• 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.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
      • Submodules
      • scholar_flux.package_metadata.directories module
      • Module contents
    • scholar_flux.security package
      • Submodules
      • scholar_flux.security.filters module
      • scholar_flux.security.masker module
      • scholar_flux.security.patterns module
      • scholar_flux.security.utils module
      • Module contents
    • scholar_flux.sessions package
      • Subpackages
      • Submodules
      • scholar_flux.sessions.encryption module
      • scholar_flux.sessions.session_manager module
      • Module contents
    • 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
  • Module contents
    • ScholarFlux API
    • APIParameterConfig
      • APIParameterConfig.DEFAULT_CORRECT_ZERO_INDEX
      • APIParameterConfig.__init__()
      • APIParameterConfig.as_config()
      • APIParameterConfig.build_parameters()
      • APIParameterConfig.from_defaults()
      • APIParameterConfig.get_defaults()
      • APIParameterConfig.map
      • APIParameterConfig.parameter_map
      • APIParameterConfig.show_parameters()
      • APIParameterConfig.structure()
    • APIParameterMap
      • APIParameterMap.query
      • APIParameterMap.start
      • APIParameterMap.records_per_page
      • APIParameterMap.api_key_parameter
      • APIParameterMap.api_key_required
      • APIParameterMap.auto_calculate_page
      • APIParameterMap.zero_indexed_pagination
      • APIParameterMap.api_specific_parameters
      • APIParameterMap.from_defaults()
      • APIParameterMap.get_defaults()
      • APIParameterMap.model_config
      • APIParameterMap.set_default_api_key_parameter()
      • APIParameterMap.validate_api_specific_parameter_mappings()
    • BaseAPI
      • BaseAPI.DEFAULT_TIMEOUT
      • BaseAPI.DEFAULT_USE_CACHE
      • BaseAPI.__init__()
      • BaseAPI.configure_session()
      • BaseAPI.prepare_request()
      • BaseAPI.send_request()
      • BaseAPI.structure()
      • BaseAPI.summary()
      • BaseAPI.user_agent
    • CachedSessionManager
      • CachedSessionManager.__init__()
      • CachedSessionManager.backend
      • CachedSessionManager.cache_directory
      • CachedSessionManager.cache_name
      • CachedSessionManager.cache_path
      • CachedSessionManager.configure_session()
      • CachedSessionManager.expire_after
      • CachedSessionManager.get_cache_directory()
      • CachedSessionManager.serializer
    • DataCacheManager
      • DataCacheManager.__init__()
      • DataCacheManager.cache_fingerprint()
      • DataCacheManager.cache_is_valid()
      • DataCacheManager.clone()
      • DataCacheManager.delete()
      • DataCacheManager.generate_fallback_cache_key()
      • DataCacheManager.generate_response_hash()
      • DataCacheManager.isnull()
      • DataCacheManager.null()
      • DataCacheManager.retrieve()
      • DataCacheManager.retrieve_from_response()
      • DataCacheManager.structure()
      • DataCacheManager.update_cache()
      • DataCacheManager.verify_cache()
      • DataCacheManager.with_storage()
    • DataExtractor
      • DataExtractor.DEFAULT_DYNAMIC_METADATA_IDENTIFIERS
      • DataExtractor.DEFAULT_DYNAMIC_RECORD_IDENTIFIERS
      • DataExtractor.__init__()
      • DataExtractor.dynamic_identification()
      • DataExtractor.extract()
    • DataParser
      • DataParser.__init__()
      • DataParser.parse()
    • DataProcessor
      • DataProcessor.__init__()
      • DataProcessor.collapse_fields()
      • DataProcessor.extract_key()
      • DataProcessor.process_page()
      • DataProcessor.process_record()
      • DataProcessor.record_filter()
    • InMemoryStorage
      • InMemoryStorage.DEFAULT_NAMESPACE
      • InMemoryStorage.DEFAULT_RAISE_ON_ERROR
      • InMemoryStorage.__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()
    • MongoDBStorage
      • MongoDBStorage.DEFAULT_CONFIG
      • MongoDBStorage.DEFAULT_NAMESPACE
      • MongoDBStorage.DEFAULT_RAISE_ON_ERROR
      • MongoDBStorage.__init__()
      • MongoDBStorage.clone()
      • MongoDBStorage.delete()
      • MongoDBStorage.delete_all()
      • MongoDBStorage.is_available()
      • MongoDBStorage.retrieve()
      • MongoDBStorage.retrieve_all()
      • MongoDBStorage.retrieve_keys()
      • MongoDBStorage.update()
      • MongoDBStorage.verify_cache()
    • MultiSearchCoordinator
      • MultiSearchCoordinator.DEFAULT_THREADED_REQUEST_DELAY
      • MultiSearchCoordinator.__init__()
      • MultiSearchCoordinator.add()
      • MultiSearchCoordinator.add_coordinators()
      • MultiSearchCoordinator.coordinators
      • MultiSearchCoordinator.current_providers()
      • MultiSearchCoordinator.group_by_provider()
      • MultiSearchCoordinator.iter_pages()
      • MultiSearchCoordinator.iter_pages_threaded()
      • MultiSearchCoordinator.search()
      • MultiSearchCoordinator.search_pages()
      • MultiSearchCoordinator.structure()
    • NullStorage
      • NullStorage.DEFAULT_NAMESPACE
      • NullStorage.DEFAULT_RAISE_ON_ERROR
      • NullStorage.__init__()
      • NullStorage.clone()
      • NullStorage.delete()
      • NullStorage.delete_all()
      • NullStorage.is_available()
      • NullStorage.retrieve()
      • NullStorage.retrieve_all()
      • NullStorage.retrieve_keys()
      • NullStorage.update()
      • NullStorage.verify_cache()
    • PassThroughDataProcessor
      • PassThroughDataProcessor.__init__()
      • PassThroughDataProcessor.process_page()
      • PassThroughDataProcessor.process_record()
      • PassThroughDataProcessor.record_filter()
    • PathDataProcessor
      • PathDataProcessor.__init__()
      • PathDataProcessor.cached
      • PathDataProcessor.discover_keys()
      • PathDataProcessor.load_data()
      • PathDataProcessor.process_page()
      • PathDataProcessor.process_record()
      • PathDataProcessor.record_filter()
      • PathDataProcessor.structure()
    • ProviderConfig
      • ProviderConfig.api_key_env_var
      • ProviderConfig.base_url
      • ProviderConfig.docs_url
      • ProviderConfig.model_config
      • ProviderConfig.normalize_provider_name()
      • ProviderConfig.parameter_map
      • ProviderConfig.provider_name
      • ProviderConfig.records_per_page
      • ProviderConfig.request_delay
      • ProviderConfig.search_config_defaults()
      • ProviderConfig.structure()
      • ProviderConfig.validate_base_url()
      • ProviderConfig.validate_docs_url()
    • RecursiveDataProcessor
      • RecursiveDataProcessor.__init__()
      • RecursiveDataProcessor.discover_keys()
      • RecursiveDataProcessor.filter_keys()
      • RecursiveDataProcessor.load_data()
      • RecursiveDataProcessor.process_page()
      • RecursiveDataProcessor.process_record()
      • RecursiveDataProcessor.record_filter()
    • RedisStorage
      • RedisStorage.DEFAULT_CONFIG
      • RedisStorage.DEFAULT_NAMESPACE
      • RedisStorage.DEFAULT_RAISE_ON_ERROR
      • RedisStorage.__init__()
      • RedisStorage.clone()
      • RedisStorage.delete()
      • RedisStorage.delete_all()
      • RedisStorage.is_available()
      • RedisStorage.retrieve()
      • RedisStorage.retrieve_all()
      • RedisStorage.retrieve_keys()
      • RedisStorage.update()
      • RedisStorage.verify_cache()
    • ResponseCoordinator
      • ResponseCoordinator.DEFAULT_VALIDATE_FINGERPRINT
      • ResponseCoordinator.__init__()
      • ResponseCoordinator.build()
      • ResponseCoordinator.cache
      • ResponseCoordinator.cache_manager
      • ResponseCoordinator.configure_cache()
      • ResponseCoordinator.extractor
      • ResponseCoordinator.handle_response()
      • ResponseCoordinator.handle_response_data()
      • ResponseCoordinator.parser
      • ResponseCoordinator.processor
      • ResponseCoordinator.schema_fingerprint()
      • ResponseCoordinator.structure()
      • ResponseCoordinator.summary()
      • ResponseCoordinator.update()
    • ResponseValidator
      • ResponseValidator.structure()
      • ResponseValidator.validate_content()
      • ResponseValidator.validate_response()
    • SQLAlchemyStorage
      • SQLAlchemyStorage.DEFAULT_CONFIG
      • SQLAlchemyStorage.DEFAULT_NAMESPACE
      • SQLAlchemyStorage.DEFAULT_RAISE_ON_ERROR
      • SQLAlchemyStorage.__init__()
      • SQLAlchemyStorage.clone()
      • SQLAlchemyStorage.delete()
      • SQLAlchemyStorage.delete_all()
      • SQLAlchemyStorage.is_available()
      • SQLAlchemyStorage.retrieve()
      • SQLAlchemyStorage.retrieve_all()
      • SQLAlchemyStorage.retrieve_keys()
      • SQLAlchemyStorage.update()
      • SQLAlchemyStorage.verify_cache()
    • SearchAPI
      • SearchAPI.DEFAULT_CACHED_SESSION
      • SearchAPI.DEFAULT_URL
      • SearchAPI.__init__()
      • SearchAPI.api_key
      • SearchAPI.api_specific_parameters
      • SearchAPI.base_url
      • SearchAPI.build_parameters()
      • SearchAPI.cache
      • SearchAPI.config
      • SearchAPI.describe()
      • SearchAPI.from_defaults()
      • SearchAPI.from_provider_config()
      • SearchAPI.from_settings()
      • SearchAPI.is_cached_session()
      • SearchAPI.make_request()
      • SearchAPI.parameter_config
      • SearchAPI.prepare_request()
      • SearchAPI.prepare_search()
      • SearchAPI.provider_name
      • SearchAPI.query
      • SearchAPI.records_per_page
      • SearchAPI.request_delay
      • SearchAPI.search()
      • SearchAPI.structure()
      • SearchAPI.summary()
      • SearchAPI.update()
      • SearchAPI.with_config()
      • SearchAPI.with_config_parameters()
    • SearchAPIConfig
      • SearchAPIConfig.provider_name
      • SearchAPIConfig.base_url
      • SearchAPIConfig.records_per_page
      • SearchAPIConfig.request_delay
      • SearchAPIConfig.api_key
      • SearchAPIConfig.api_specific_parameters
      • SearchAPIConfig.DEFAULT_PROVIDER
      • SearchAPIConfig.DEFAULT_RECORDS_PER_PAGE
      • SearchAPIConfig.DEFAULT_REQUEST_DELAY
      • SearchAPIConfig.MAX_API_KEY_LENGTH
      • SearchAPIConfig.api_key
      • SearchAPIConfig.api_specific_parameters
      • SearchAPIConfig.base_url
      • SearchAPIConfig.default_request_delay()
      • SearchAPIConfig.from_defaults()
      • SearchAPIConfig.model_config
      • SearchAPIConfig.provider_name
      • SearchAPIConfig.records_per_page
      • SearchAPIConfig.request_delay
      • SearchAPIConfig.set_records_per_page()
      • SearchAPIConfig.structure()
      • SearchAPIConfig.update()
      • SearchAPIConfig.url_basename
      • SearchAPIConfig.validate_api_key()
      • SearchAPIConfig.validate_provider_name()
      • SearchAPIConfig.validate_request_delay()
      • SearchAPIConfig.validate_search_api_config_parameters()
      • SearchAPIConfig.validate_url()
      • SearchAPIConfig.validate_url_type()
    • SearchCoordinator
      • SearchCoordinator.__init__()
      • SearchCoordinator.as_coordinator()
      • SearchCoordinator.fetch()
      • SearchCoordinator.get_cached_request()
      • SearchCoordinator.get_cached_response()
      • SearchCoordinator.iter_pages()
      • SearchCoordinator.robust_request()
      • SearchCoordinator.search()
      • SearchCoordinator.search_data()
      • SearchCoordinator.search_pages()
      • SearchCoordinator.update()
    • SessionManager
      • SessionManager.__init__()
      • SessionManager.configure_session()