Merge pull request #780 from superannotateai/develop

Develop

Author: VaghinakDev

CHANGELOG.rst

@@ -6,12 +6,29 @@ History
 
 All release highlights of this project will be documented in this file.
 
+4.4.33 - April 1, 2025
+______________________
+
+**Added**
+
+    - ``SAClient.get_user_scores`` Retrieves score metadata for a user on a specific item within a project.
+    - ``SAClient.user_scores`` Assigns or updates score metadata for a user on a specific item in a project.
+
+**Updated**
+
+    - ``SAClient.prepare_export`` Added option for JSONL download type.
+    - ``SAClient.download_annotations`` Added data_spec parameter enabling annotation downloads in JSONL format for multimodal projects.
+    - ``SAClient.list_items`` Introduced a new parameter to filter results by item category.
+    - ``SAClient.list_users`` Now retrieves a list of users with their scores and includes filtering options. Added an optional project parameter to fetch project-level scores instead of team-level scores.
+    - ``SAClient.item_context`` Added information about the ItemContext nested class.
+    - ``SAClient.list_projects`` Enhanced docstrings for to improve clarity and usability.
+
 4.4.32 - March 4, 2025
-_____________________
+______________________
 
 **Fixed**
 
-    - ``SAClient.item_context`` Fixed an issue where setting a component value would overwrite existing comments and other associated data. 
+    - ``SAClient.item_context`` Fixed an issue where setting a component value would overwrite existing comments and other associated data.
 
 4.4.31 - Feb 27, 2025
 _____________________

docs/source/api_reference/api_item.rst

@@ -9,6 +9,10 @@ Items
 .. automethod:: superannotate.SAClient.search_items
 .. automethod:: superannotate.SAClient.attach_items
 .. automethod:: superannotate.SAClient.item_context
+.. autoclass:: superannotate.ItemContext
+    :members: get_metadata, get_component_value, set_component_value
+    :member-order: bysource
+
 .. automethod:: superannotate.SAClient.copy_items
 .. automethod:: superannotate.SAClient.move_items
 .. automethod:: superannotate.SAClient.delete_items

docs/source/api_reference/api_team.rst

@@ -12,3 +12,5 @@ Team
 .. automethod:: superannotate.SAClient.list_users
 .. automethod:: superannotate.SAClient.pause_user_activity
 .. automethod:: superannotate.SAClient.resume_user_activity
+.. automethod:: superannotate.SAClient.get_user_scores
+.. automethod:: superannotate.SAClient.set_user_scores

docs/source/userguide/quickstart.rst

@@ -32,7 +32,7 @@ Initialization and authorization
 ================================
 
 To use the SDK, you need to create a config file with a team-specific authentication token. The token is available
-to team admins on the team settings page at https://app.superannotate.com/team.
+to team admins on the team settings page at https://doc.superannotate.com/docs/token-for-python-sdk#generate-a-token-for-python-sdk.
 
 SAClient can be used with or without arguments
 ______________________________________________

docs/source/userguide/setup_project.rst

@@ -74,7 +74,7 @@ An annotation class for a project can be created with SDK's:
 
 To create annotation classes in bulk with SuperAnnotate export format
 :file:`classes.json` (documentation at:
-https://app.superannotate.com/documentation Management Tools
+https://superannotate.readthedocs.io/en/stable/userguide/setup_project.html#working-with-annotation-classes Ma`nagement Tools
 -> Project Workflow part):
 
 .. code-block:: python

pytest.ini

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

src/superannotate/__init__.py

@@ -3,7 +3,8 @@
 import sys
 
 
-__version__ = "4.4.32"
+__version__ = "4.4.33"
+
 
 os.environ.update({"sa_version": __version__})
 sys.path.append(os.path.split(os.path.realpath(__file__))[0])
@@ -20,6 +21,7 @@
 from superannotate.lib.app.input_converters import export_annotation
 from superannotate.lib.app.input_converters import import_annotation
 from superannotate.lib.app.interface.sdk_interface import SAClient
+from superannotate.lib.app.interface.sdk_interface import ItemContext
 
 
 SESSIONS = {}
@@ -28,6 +30,7 @@
 __all__ = [
     "__version__",
     "SAClient",
+    "ItemContext",
     # Utils
     "enums",
     "AppException",