Add team metadata retrieval

Author: hovnatan

docs/source/superannotate.sdk.rst

@@ -101,6 +101,7 @@ __________________
 Team contributors
 _________________
 
+.. autofunction:: superannotate.get_team_metadata
 .. autofunction:: superannotate.invite_contributor_to_team
 
 ----------

superannotate/__init__.py

@@ -53,7 +53,7 @@
     upload_images_from_s3_bucket_to_project, upload_images_to_project,
     upload_preannotations_from_folder_to_project
 )
-from .db.teams import invite_contributor_to_team
+from .db.teams import get_team_metadata, invite_contributor_to_team
 from .db.users import search_team_contributors
 from .dicom_converter import dicom_to_rgb_sequence
 from .exceptions import (

superannotate/db/teams.py

@@ -1,6 +1,7 @@
 import logging
 
 from ..api import API
+from ..common import user_role_int_to_str
 from ..exceptions import SABaseException
 
 logger = logging.getLogger("superannotate-python-sdk")
@@ -12,7 +13,7 @@ def invite_contributor_to_team(email, admin=False):
     """Invites a contributor to team
 
     :param email: email of the contributor
-    :type project: str
+    :type email: str
     :param admin: enables admin priviledges for the contributor
     :type admin: bool
     """
@@ -29,6 +30,28 @@ def invite_contributor_to_team(email, admin=False):
     return response.json()
 
 
+def get_team_metadata(convert_users_role_to_string=False):
+    """Returns team metadata
+
+    :param convert_users_role_to_string: convert integer team users' roles to human comprehensible strings
+    :type convert_users_role_to_string: bool
+    :return: team metadata
+    :rtype: dict
+    """
+    response = _api.send_request(req_type='GET', path=f'/team/{_api.team_id}')
+    if not response.ok:
+        raise SABaseException(
+            response.status_code, "Couldn't get team metadata. " + response.text
+        )
+
+    res = response.json()
+    if convert_users_role_to_string:
+        for user in res["users"]:
+            user["user_role"] = user_role_int_to_str(user["user_role"])
+
+    return res
+
+
 # def delete_team_contributor_invitation(invitation):
 #     """Deletes team contributor invitation
 

tests/test_team_metadata.py

@@ -0,0 +1,11 @@
+from pathlib import Path
+
+import superannotate as sa
+
+sa.init(Path.home() / ".superannotate" / "config.json")
+
+
+def test_team_metadata():
+    metadata = sa.get_team_metadata(convert_users_role_to_string=True)
+    print(len(metadata["users"]))
+    print(metadata["users"])