Consensus package

Data folders

• Consensus.config folder
  • Module contents
• Consensus.lookups folder
  • Module contents
• Consensus.PickleJar folder
  • Module contents

Submodules

• Consensus.ConfigManager module
  • Usage:
  • ConfigManager
    • ConfigManager.config_file
    • ConfigManager.DEFAULT_CONFIG
    • ConfigManager.reset_config()
    • ConfigManager.DEFAULT_CONFIG
    • ConfigManager.__init__()
    • ConfigManager.reset_config()
    • ConfigManager.save_config()
    • ConfigManager.update_config()
• Consensus.EsriConnector module
  • Extending EsriConnector() class
  • FeatureServer() class example
  • EsriConnector
    • EsriConnector.base_url
    • EsriConnector.max_retries
    • EsriConnector.retry_delay
    • EsriConnector.server_types
    • EsriConnector.services
    • EsriConnector.service_table
    • EsriConnector._name
    • EsriConnector._initialise()
    • EsriConnector._load_all_services()
    • EsriConnector.print_all_services()
    • EsriConnector.__init__()
    • EsriConnector._fetch_response()
    • EsriConnector._initialise()
    • EsriConnector._load_all_services()
    • EsriConnector._name
    • EsriConnector.base_url
    • EsriConnector.build_lookup()
    • EsriConnector.connect_to_server()
    • EsriConnector.field_matching_condition()
    • EsriConnector.get_layer_obj()
    • EsriConnector.metadata_as_pandas()
    • EsriConnector.print_all_services()
    • EsriConnector.print_object_data()
    • EsriConnector.select_layers_by_layers()
    • EsriConnector.select_layers_by_service()
  • FeatureServer
    • FeatureServer.feature_service
    • FeatureServer.max_retries
    • FeatureServer.retry_delay
    • FeatureServer.chunk_size
    • FeatureServer.__init__()
    • FeatureServer.chunker()
    • FeatureServer.download()
    • FeatureServer.looper()
    • FeatureServer.setup()
  • Layer
    • Layer.full_name
    • Layer.service_name
    • Layer.layer_name
    • Layer.id
    • Layer.fields
    • Layer.url
    • Layer.description
    • Layer.primary_key
    • Layer.matchable_fields
    • Layer.lasteditdate
    • Layer.data_from_layers
    • Layer.has_geometry
    • Layer.type
    • Layer.__init__()
    • Layer._fetch()
    • Layer._record_count()
    • Layer.data_from_layers
    • Layer.description
    • Layer.fields
    • Layer.full_name
    • Layer.has_geometry
    • Layer.id
    • Layer.lasteditdate
    • Layer.layer_name
    • Layer.matchable_fields
    • Layer.primary_key
    • Layer.service_name
    • Layer.type
    • Layer.url
  • Service
    • Service.name
    • Service.type
    • Service.url
    • Service.description
    • Service.layers
    • Service.tables
    • Service.output_formats
    • Service.metadata
    • Service.fields
    • Service.primary_key
    • Service.field_matching_condition
    • Service.featureservers()
    • Service.mapservers()
    • Service.wfsservers()
    • Service.get_download_urls()
    • Service._matchable_fields()
    • Service.__init__()
    • Service._fetch()
    • Service._matchable_fields()
    • Service._service_attributes()
    • Service.description
    • Service.featureservers()
    • Service.field_matching_condition
    • Service.fields
    • Service.get_download_urls()
    • Service.get_layers()
    • Service.layers
    • Service.mapservers()
    • Service.metadata
    • Service.name
    • Service.output_formats
    • Service.primary_key
    • Service.service_details()
    • Service.service_metadata()
    • Service.tables
    • Service.type
    • Service.url
    • Service.wfsservers()
• Consensus.EsriServers module
  • OpenGeography
    • OpenGeography.__init__()
    • OpenGeography._fetch_response()
    • OpenGeography._initialise()
    • OpenGeography._load_all_services()
    • OpenGeography._name
    • OpenGeography.base_url
    • OpenGeography.build_lookup()
    • OpenGeography.connect_to_server()
    • OpenGeography.field_matching_condition()
    • OpenGeography.get_layer_obj()
    • OpenGeography.metadata_as_pandas()
    • OpenGeography.print_all_services()
    • OpenGeography.print_object_data()
    • OpenGeography.select_layers_by_layers()
    • OpenGeography.select_layers_by_service()
  • TFL
    • TFL.__init__()
    • TFL._fetch_response()
    • TFL._initialise()
    • TFL._load_all_services()
    • TFL._name
    • TFL.base_url
    • TFL.build_lookup()
    • TFL.connect_to_server()
    • TFL.field_matching_condition()
    • TFL.get_layer_obj()
    • TFL.metadata_as_pandas()
    • TFL.print_all_services()
    • TFL.print_object_data()
    • TFL.select_layers_by_layers()
    • TFL.select_layers_by_service()
• Consensus.GeocodeMerger module
  • Using SmartLinker()
  • Usage:
    • Intended workflow
  • BFS_SP()
  • GeoHelper
    • GeoHelper.None
    • GeoHelper.__init__()
    • GeoHelper.available_geographies()
    • GeoHelper.geographies_filter()
    • GeoHelper.geography_keys()
  • InvalidColumnError
    • InvalidColumnError.__init__()
    • InvalidColumnError.add_note()
    • InvalidColumnError.args
    • InvalidColumnError.with_traceback()
  • InvalidPathError
    • InvalidPathError.__init__()
    • InvalidPathError.add_note()
    • InvalidPathError.args
    • InvalidPathError.with_traceback()
  • MissingDataError
    • MissingDataError.__init__()
    • MissingDataError.add_note()
    • MissingDataError.args
    • MissingDataError.with_traceback()
  • SmartLinker
    • SmartLinker.server
    • SmartLinker.lookup_location
    • SmartLinker.graph
    • SmartLinker.lookup
    • SmartLinker.local_authorities
    • SmartLinker.run_graph()
    • SmartLinker.geodata()
    • SmartLinker.allow_geometry()
    • SmartLinker.__init__()
    • SmartLinker._check_intersection_of_two_lists()
    • SmartLinker._create_graph()
    • SmartLinker._find_paths()
    • SmartLinker._find_shortest_paths()
    • SmartLinker._get_ogp_table()
    • SmartLinker._get_starting_point()
    • SmartLinker._get_starting_point_without_local_authority_constraint()
    • SmartLinker._initialise()
    • SmartLinker._path_to_tables()
    • SmartLinker.allow_geometry()
    • SmartLinker.geodata()
    • SmartLinker.paths_to_explore()
    • SmartLinker.run_graph()
• Consensus.LGInform module
  • LGInform
    • LGInform.api_key
    • LGInform.api_secret
    • LGInform.proxies
    • LGInform.area
    • LGInform.__init__()
    • LGInform._multiprocessing_wrapper()
    • LGInform.download()
    • LGInform.download_data_for_many_variables()
    • LGInform.download_variable_data()
    • LGInform.format_tables()
    • LGInform.get_dataset_table_variables()
    • LGInform.json_to_pandas()
    • LGInform.merge_tables()
    • LGInform.mp_download()
    • LGInform.sign_url()
• Consensus.LocalMerger module
  • DatabaseManager
    • DatabaseManager.db_path
    • DatabaseManager.conn
    • DatabaseManager.__init__()
    • DatabaseManager._join_tables()
    • DatabaseManager.close()
    • DatabaseManager.create_database()
    • DatabaseManager.list_all_tables()
    • DatabaseManager.query_tables_from_path()
  • GraphBuilder
    • GraphBuilder.directory_path
    • GraphBuilder.graph
    • GraphBuilder._build_graph()
    • GraphBuilder.get_table_paths()
    • GraphBuilder.get_full_graph()
    • GraphBuilder.__init__()
    • GraphBuilder._build_graph()
    • GraphBuilder._process_csv()
    • GraphBuilder._process_dataframe()
    • GraphBuilder._process_excel()
    • GraphBuilder.bfs_paths()
    • GraphBuilder.choose_path()
    • GraphBuilder.find_paths()
    • GraphBuilder.get_all_possible_paths()
    • GraphBuilder.get_full_graph()
    • GraphBuilder.get_table_paths()
• Consensus.Nomis module
  • API keys and connecting to NOMIS
  • Example usage
  • ConnectToNomis
    • ConnectToNomis.api_key
    • ConnectToNomis.proxies
    • ConnectToNomis.uid
    • ConnectToNomis.base_url
    • ConnectToNomis.url
    • ConnectToNomis.r
    • ConnectToNomis.config
    • ConnectToNomis.__init__()
    • ConnectToNomis._create_geography_e_code()
    • ConnectToNomis._find_exact_table()
    • ConnectToNomis._geography_edges()
    • ConnectToNomis._unpack_geography_list()
    • ConnectToNomis.connect()
    • ConnectToNomis.detailed_info_for_table()
    • ConnectToNomis.get_all_tables()
    • ConnectToNomis.get_table_columns()
    • ConnectToNomis.print_table_info()
    • ConnectToNomis.url_creator()
  • DownloadFromNomis
    • DownloadFromNomis.api_key
    • DownloadFromNomis.proxies
    • DownloadFromNomis.uid
    • DownloadFromNomis.base_url
    • DownloadFromNomis.url
    • DownloadFromNomis.r
    • DownloadFromNomis.config
    • DownloadFromNomis.__init__()
    • DownloadFromNomis.__init__()
    • DownloadFromNomis._bulk_download_url()
    • DownloadFromNomis._create_geography_e_code()
    • DownloadFromNomis._download_checks()
    • DownloadFromNomis._download_file()
    • DownloadFromNomis._download_to_pandas()
    • DownloadFromNomis._find_exact_table()
    • DownloadFromNomis._geography_edges()
    • DownloadFromNomis._unpack_geography_list()
    • DownloadFromNomis.bulk_download()
    • DownloadFromNomis.connect()
    • DownloadFromNomis.detailed_info_for_table()
    • DownloadFromNomis.download()
    • DownloadFromNomis.get_all_tables()
    • DownloadFromNomis.get_table_columns()
    • DownloadFromNomis.print_table_info()
    • DownloadFromNomis.table_to_csv()
    • DownloadFromNomis.url_creator()
  • NomisTable
    • NomisTable.agencyid
    • NomisTable.annotations
    • NomisTable.id
    • NomisTable.components
    • NomisTable.name
    • NomisTable.uri
    • NomisTable.version
    • NomisTable.description
    • NomisTable.__init__()
    • NomisTable.agencyid
    • NomisTable.annotations
    • NomisTable.clean_annotations()
    • NomisTable.components
    • NomisTable.description
    • NomisTable.detailed_description()
    • NomisTable.get_table_cols()
    • NomisTable.id
    • NomisTable.name
    • NomisTable.table_cols()
    • NomisTable.table_shorthand()
    • NomisTable.uri
    • NomisTable.version
• Consensus.config_utils module
  • Load the config.json
  • load_config()
• Consensus.utils module
  • Utility functions
  • read_lookup()
  • read_service_table()
  • where_clause_maker()
• Consensus.server_selector_util module
  • Purpose of server_selector_util
  • get_server()
  • get_server_name()
  • server_selector()

Module contents