Add name and owner parameters to ToolShedRepositoryClient.get_repositories()

xref. #462 (comment)

Author: nsoranzo

CHANGELOG.md

@@ -16,6 +16,9 @@
   ``WorkflowClient.invoke_workflow()`` method (thanks to
   [cat-bro](https://github.com/cat-bro)).
 
+* Added ``name`` and ``owner`` parameters to
+  ``ToolShedRepositoryClient.get_repositories()``.
+
 * Remove unused methods from ``bioblend.config.Config``. If needed, use the
   methods inherited from `configparser.ConfigParser` instead.
 

bioblend/_tests/TestToolshed.py

@@ -36,13 +36,18 @@ def test_repositories_client(self):
         assert len(repositories) > 5000
         assert repositories[0]["model_class"] == "Repository"
 
+        repositories = self.ts.repositories.get_repositories(name="bam_to_sam", owner="devteam")
+        assert len(repositories) == 1
+        bam_to_sam_repo = repositories[0]
+        assert bam_to_sam_repo["name"] == "bam_to_sam"
+        assert bam_to_sam_repo["owner"] == "devteam"
+
         # search_repositories
         samtools_search = self.ts.repositories.search_repositories("samtools", page_size=5)
         assert int(samtools_search["total_results"]) > 20
         assert len(samtools_search["hits"]) == 5
 
         # show_repository
-        bam_to_sam_repo = [r for r in repositories if r["name"] == "bam_to_sam"][0]
         show_bam_to_sam_repo = self.ts.repositories.show_repository(bam_to_sam_repo["id"])
         assert "SAM" in show_bam_to_sam_repo["long_description"]
 

bioblend/toolshed/repositories/__init__.py

@@ -25,9 +25,16 @@ class ToolShedRepositoryClient(Client):
     def __init__(self, toolshed_instance: "ToolShedInstance") -> None:
         super().__init__(toolshed_instance)
 
-    def get_repositories(self) -> List[Dict[str, Any]]:
+    def get_repositories(self, name: Optional[str] = None, owner: Optional[str] = None) -> List[Dict[str, Any]]:
         """
-        Get a list of all the repositories in a Galaxy Tool Shed.
+        Get all repositories in a Galaxy Tool Shed, or select a subset by
+        specifying optional arguments for filtering (e.g. a repository name).
+
+        :type name: str
+        :param name: Repository name to filter on.
+
+        :type owner: str
+        :param owner: Repository owner to filter on.
 
         :rtype: list
         :return: Returns a list of dictionaries containing information about
@@ -54,7 +61,12 @@ def get_repositories(self) -> List[Dict[str, Any]]:
           Changed method name from ``get_tools`` to ``get_repositories`` to
           better align with the Tool Shed concepts.
         """
-        return self._get()
+        params = {}
+        if name:
+            params["name"] = name
+        if owner:
+            params["owner"] = owner
+        return self._get(params=params)
 
     def search_repositories(
         self,