Update docs

Author: hovnatan

docs/source/superannotate.sdk.rst

@@ -31,6 +31,8 @@ ________
 .. autofunction:: superannotate.get_project_metadata
 .. autofunction:: superannotate.get_project_image_count
 .. autofunction:: superannotate.get_project_and_folder_metadata
+.. autofunction:: superannotate.search_folders
+.. autofunction:: superannotate.get_folder_metadata
 .. autofunction:: superannotate.create_folder
 .. autofunction:: superannotate.delete_folders
 .. autofunction:: superannotate.rename_folder

superannotate/db/project_api.py

@@ -66,6 +66,16 @@ def get_project_metadata_with_users(project_metadata):
 
 
 def get_folder_metadata(project, folder_name):
+    """Returns folder metadata
+
+    :param project: project name
+    :type project: str
+    :param folder_name: folder's name
+    :type folder_name: str
+
+    :return: metadata of folder
+    :rtype: dict
+    """
     if not isinstance(project, dict):
         project = get_project_metadata_bare(project)
     team_id, project_id = project["team_id"], project["id"]
@@ -83,6 +93,17 @@ def get_folder_metadata(project, folder_name):
 
 
 def get_project_and_folder_metadata(project):
+    """Returns project and folder metadata tuple. If folder part is empty, 
+    than returned folder part is set to None.
+
+    :param project: project name or folder path (e.g., "project1/folder1")
+    :type project: str
+    :param folder_name: folder's name
+    :type folder_name: str
+
+    :return: metadata of folder
+    :rtype: dict
+    """
     if isinstance(project, dict):
         project = project
         folder = None
@@ -112,6 +133,18 @@ def get_project_and_folder_metadata(project):
 
 
 def search_folders(project, folder_name=None, return_metadata=False):
+    """Folder name based case-insensitive search for folders in project.
+
+    :param project: project name
+    :type project: str
+    :param folder_name: the new folder's name
+    :type folder_name: str. If  None, all the folders in the project will be returned.
+    :param return_metadata: return metadata of folders instead of names
+    :type return_metadata: bool
+
+    :return: folder names or metadatas
+    :rtype: list of strs or dicts
+    """
     if not isinstance(project, dict):
         project = get_project_metadata_bare(project)
     team_id, project_id = project["team_id"], project["id"]

superannotate/db/projects.py

@@ -1975,8 +1975,8 @@ def get_project_metadata(
 ):
     """Returns project metadata
 
-    :param project: project name or project metadata from previous calls
-    :type project: str or dict
+    :param project: project name
+    :type project: str
     :param include_annotation_classes: enables project annotation classes output under
                                        the key "annotation_classes"
     :type include_annotation_classes: bool

superannotate/db/search_projects.py

@@ -16,7 +16,7 @@ def search_projects(
 
     :param name: search string
     :type name: str
-    :param return_metadata: return metadata of images instead of names
+    :param return_metadata: return metadata of projects instead of names
     :type return_metadata: bool
 
     :return: project names or metadatas