Mercurial > repos > shellac > sam_consensus_v3
diff env/lib/python3.9/site-packages/bioblend/toolshed/tools/__init__.py @ 0:4f3585e2f14b draft default tip
"planemo upload commit 60cee0fc7c0cda8592644e1aad72851dec82c959"
author | shellac |
---|---|
date | Mon, 22 Mar 2021 18:12:50 +0000 |
parents | |
children |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/env/lib/python3.9/site-packages/bioblend/toolshed/tools/__init__.py Mon Mar 22 18:12:50 2021 +0000 @@ -0,0 +1,50 @@ +""" +Interaction with a Tool Shed instance tools +""" +from bioblend.galaxy.client import Client + + +class ToolShedToolClient(Client): + + def __init__(self, toolshed_instance): + self.module = 'tools' + super().__init__(toolshed_instance) + + def search_tools(self, q, page=1, page_size=10): + """ + Search for tools in a Galaxy Tool Shed. + + :type q: str + :param q: query string for searching purposes + + :type page: int + :param page: page requested + + :type page_size: int + :param page_size: page size requested + + :rtype: dict + :return: dictionary containing search hits as well as metadata for the + search. For example:: + + {'hits': [{'matched_terms': [], + 'score': 3.0, + 'tool': {'description': 'convert between various FASTQ quality formats', + 'id': '69819b84d55f521efda001e0926e7233', + 'name': 'FASTQ Groomer', + 'repo_name': None, + 'repo_owner_username': 'devteam'}}, + {'matched_terms': [], + 'score': 3.0, + 'tool': {'description': 'converts a bam file to fastq files.', + 'id': '521e282770fd94537daff87adad2551b', + 'name': 'Defuse BamFastq', + 'repo_name': None, + 'repo_owner_username': 'jjohnson'}}], + 'hostname': 'https://testtoolshed.g2.bx.psu.edu/', + 'page': '1', + 'page_size': '2', + 'total_results': '118'} + """ + params = dict(q=q, page=page, page_size=page_size) + return self._get(params=params)