API Documentation¶
-
class
Fetcher
(base_url)¶ Act as a factory class for sequence and metadata
Parameters: base_url (string) – Base url of the server from which data to be fetched -
get_base_url
()¶ Return base_url of the Fetcher object
Return type: string
-
set_base_url
(base_url)¶ Set base_url of the Fetcher object. Used to change the base url of already instantiated object on the fly.
Parameters: base_url (string) – Base url of the server from which data to be fetched Return type: void
-
fetch_info
()¶ Returns the service information of the server being queried
Return type: dict
-
fetch_sequence
(checksum[, start=None, end=None])¶ Act as factory method for retrieving sequences
Parameters: - checksum (string) – Checksum identifier of the sequence to be retrieved
- start (integer) – Used to define start location of the sequence to be retrieved (inclusive)
- end (integer) – Used to define end location of the sequence to be retrieved (exclusive)
Return type: string
-
fetch_metadata
(checksum)¶ Act as factory method for retrieving sequences
param checksum: Checksum identifier of the sequence to be retrieved :type checksum: string
Return type: dict
-
classmethod
info
(base_url)¶ A class method for easily fetching single service info without creating Fetcher object.
Return type: dict
-
classmethod
sequence
(base_url, checksum[, start=None, end=None])¶ A class method for easily fetching single sequence without creating Fetcher object. Parameters definitions as per defined above
Return type: string
-
classmethod
metdata
(base_url, checksum)¶ A class method for easily fetching single metadata without creating Fetcher object. Parameters definitions as per defined above
Return type: dict
-