[BitBucket] Add get_groups method (atlassian-api#1356)

Co-authored-by: Stéphane BILQUÉ <[email protected]>

atlassian/bitbucket/__init__.py

@@ -39,6 +39,26 @@ def markup_preview(self, data):
     def _url_admin(self, api_version=None):
         return self.resource_url("admin", api_version=api_version)
 
+    def get_groups(self, group_filter=None, limit=25, start=0):
+        """
+        Get list of bitbucket groups.
+        Use 'group_filter' for get specific group or get all group if necessary.
+
+        :param group_filter: str - groupname
+        :param limit: int - paginated limit to retrieve
+        :param start: int - paginated point to start retrieving
+        :return: The collection as JSON with all relevant information about the group
+        """
+        url = self.resource_url("groups", api_version="1.0")
+        params = {}
+        if group_filter:
+            params["filter"] = group_filter
+        if limit:
+            params["limit"] = limit
+        if start:
+            params["start"] = start
+        return self._get_paged(url, params=params)
+
     def group_members(self, group, start=0, limit=None):
         """
         Get group of members

docs/bitbucket.rst

@@ -160,6 +160,9 @@ Groups and admins
 
 .. code-block:: python
 
+    # Get groups. Use 'group_filter' parameter to get specific groups.
+    bitbucket.groups(group_filter="group", limit=99999)
+
     # Get group of members
     bitbucket.group_members(group, limit=99999)
 

examples/bitbucket/bitbucket_groups.py

@@ -0,0 +1,7 @@
+# coding=utf-8
+from atlassian import Bitbucket
+
+bitbucket = Bitbucket(url="http://localhost:7990", username="admin", password="admin")
+
+data = bitbucket.get_groups(group_filter="group")
+print(data)