Doc updates

Author: VaghinakDev

docs/source/api_reference/api_metadata.rst

@@ -104,43 +104,37 @@ Item metadata example:
 .. code-block:: python
 
   {
-   "name": "example.jpeg",
-   "path": "project/folder_1/meow.jpeg",
-   "url": "https://sa-public-files.s3.../text_file_example_1.jpeg",
-   "annotation_status": "NotStarted",
-   "annotator_name": None,
-   "qa_name": None,
-   "entropy_value": None,
-   "createdAt": "2022-02-15T20:46:44.000Z",
-   "updatedAt": "2022-02-15T20:46:44.000Z"
-    }
-
-----------
-
-
-Image metadata
-_______________
-
-
-Image metadata example:
-
-.. code-block:: python
-
-   {
-      "name": "000000000001.jpg",
-      "annotation_status": "Completed",
-      "annotator_id": None,
-      "annotator_name": None,
-      "qa_id": None,
-      "qa_name": None,
-      "entropy_value": None,
-      "approval_status": None,
-      "createdAt": "2020-08-18T07:30:06.000Z",
-      "updatedAt": "2020-08-18T07:30:06.000Z"
-      "is_pinned": 0,
-      "...": "...",
+  "createdAt": "2022-09-14T07:06:53.000Z",
+   "updatedAt": "2022-09-30T13:14:26.000Z",
+   "id": 33027004,
+   "name": "5199856037_03d1929b7b_o.jpg",
+   "path": "New Classes",
+   "url": "None",
+  "assignments": [
+      {
+         "user_role": "Annotator",
+         "user_id": "annotator@example.com"
+      },
+      {
+         "user_role": "QA",
+         "user_id": "qa@example.com"
+      },
+      {
+         "user_role": "reviewer",
+         "user_id": null
+      },
+      {
+         "user_role": "<role_name",
+         "user_id": "my@example.com"
+      }
+   ],
+   "entropy_value": "None",
+   "custom_metadata": {
+      "study_date": "2021-12-31",
+      "patient_id": "A1234567890",
+      "medical_specialist": "dr.smith@clinic.com",
+   }
    }
-
 
 ----------
 

pytest.ini

@@ -3,4 +3,4 @@ minversion = 3.7
 log_cli=true
 python_files = test_*.py
 ;pytest_plugins = ['pytest_profiling']
-;addopts = -n auto --dist=loadscope
+addopts = -n auto --dist=loadscope

src/superannotate/__init__.py

@@ -3,7 +3,7 @@
 import sys
 
 
-__version__ = "4.4.25dev1"
+__version__ = "4.4.25dev2"
 
 os.environ.update({"sa_version": __version__})
 sys.path.append(os.path.split(os.path.realpath(__file__))[0])

src/superannotate/lib/app/interface/cli_interface.py

@@ -88,7 +88,7 @@ def upload_images(
         project: str,
         folder: str,
         extensions: str = constances.DEFAULT_IMAGE_EXTENSIONS,
-        set_annotation_status: str = constances.AnnotationStatus.NOT_STARTED.name,
+        set_annotation_status: str = None,
         exclude_file_patterns=constances.DEFAULT_FILE_EXCLUDE_PATTERNS,
         recursive_subfolders=False,
         image_quality_in_editor=None,
@@ -243,7 +243,7 @@ def upload_videos(
         target_fps=None,
         recursive=False,
         extensions=constances.DEFAULT_VIDEO_EXTENSIONS,
-        set_annotation_status=constances.AnnotationStatus.NOT_STARTED.name,
+        set_annotation_status=None,
         start_time=0.0,
         end_time=None,
     ):

src/superannotate/lib/app/interface/sdk_interface.py

@@ -320,7 +320,7 @@ def create_project(
         :type workflows: list of dicts
 
         :param workflow: the name of the workflow already created within the team, which must match exactly.
-                         If None, the default “Annotator can’t complete” system workflow will be set.
+                         If None, the default “System workflow” workflow will be set.
         :type workflow: str
 
         :param instructions_link: str of instructions URL
@@ -2262,7 +2262,7 @@ def add_contributors_to_project(
         self,
         project: NotEmptyStr,
         emails: conlist(EmailStr, min_items=1),
-        role: ANNOTATOR_ROLE,
+        role: str,
     ) -> Tuple[List[str], List[str]]:
         """Add contributors to project.
 
@@ -2318,7 +2318,7 @@ def invite_contributors_to_team(
 
     def get_annotations(
         self,
-        project: Union[NotEmptyStr, int],
+        project: Union[int, NotEmptyStr],
         items: Optional[Union[List[NotEmptyStr], List[int]]] = None,
     ):
         """Returns annotations for the given list of items.
@@ -2663,8 +2663,8 @@ def search_items(
 
     def list_items(
         self,
-        project: Union[str, int],
-        folder: Optional[Union[str, int]] = None,
+        project: Union[int, str],
+        folder: Optional[Union[int, str]] = None,
         *,
         include: List[Literal["assignments", "custom_metadata"]] = None,
         **filters,
@@ -2674,12 +2674,12 @@ def list_items(
 
         :param project: The project name, project ID, or folder path (e.g., "project1/folder1") to search within.
                         This can refer to the root of the project or a specific subfolder.
-        :type project: Union[str, int]
+        :type project: Union[int, str]
 
         :param folder: The folder name or ID to search within. If None, the search will be done in the root folder of
                        the project. If both “project” and “folder” specify folders, the “project”
                        value will take priority.
-        :type folder: Union[str, int], optional
+        :type folder: Union[int, str], optional
 
         :param include: Specifies additional fields to include in the response.
 
@@ -2771,15 +2771,17 @@ def list_items(
             )
         """
         project = (
-            project
+            self.controller.get_project_by_id(project).data
             if isinstance(project, int)
             else self.controller.get_project(project)
         )
         if folder is None:
             folder = self.controller.get_folder(project, "root")
         else:
             if isinstance(folder, int):
-                folder = self.controller.get_folder_by_id(project.id, folder)
+                folder = self.controller.get_folder_by_id(
+                    project_id=project.id, folder_id=folder
+                ).data
             else:
                 folder = self.controller.get_folder(project, folder)
         include = include or []

src/superannotate/lib/infrastructure/controller.py

@@ -8,7 +8,6 @@
 from typing import List
 from typing import Optional
 from typing import Tuple
-from typing import TypedDict
 from typing import Union
 
 import lib.core as constances
@@ -45,6 +44,8 @@
 from lib.infrastructure.services.http_client import HttpClient
 from lib.infrastructure.utils import divide_to_chunks
 from lib.infrastructure.utils import extract_project_folder
+from typing_extensions import TypedDict
+from typing_extensions import Unpack
 
 
 class ItemFilters(TypedDict, total=False):
@@ -58,15 +59,15 @@ class ItemFilters(TypedDict, total=False):
     annotation_status: Optional[str]
     annotation_status__in: Optional[List[str]]
     approval_status: Optional[str]
-    approval_status__in: Optional[str]
+    approval_status__in: Optional[List[str]]
     approval_status__ne: Optional[str]
     assignments__user_id: Optional[str]
     assignments__user_id__in: Optional[List[str]]
     assignments__user_id__ne: Optional[str]
     assignments__user_role: Optional[str]
-    assignments__user_role__in: Optional[str]
+    assignments__user_role__in: Optional[List[str]]
     assignments__user_role__ne: Optional[str]
-    assignments__user_role__notin: Optional[str]
+    assignments__user_role__notin: Optional[List[str]]
 
 
 def build_condition(**kwargs) -> Condition:
@@ -485,7 +486,7 @@ def list_items(
         folder: FolderEntity,
         /,
         include: List[str] = None,
-        **filters,
+        **filters: Unpack[ItemFilters],
     ) -> List[BaseItemEntity]:
 
         query = self._build_query(project, filters, include)