Skip to content

Commit e9c7384

Browse files
committed
Docstring updated
1 parent 42075d1 commit e9c7384

File tree

4 files changed

+33
-7
lines changed

4 files changed

+33
-7
lines changed

CHANGELOG.rst

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,26 @@ History
66

77
All release highlights of this project will be documented in this file.
88

9+
4.4.23 - July 4, 2024
10+
_______________________
11+
12+
13+
**Updated**
14+
15+
- ``SAClient.prepare_export`` added the ability to export GenAI project data to a CSV file..
16+
17+
**Fiexed**
18+
19+
- ``SAClient.upload_priority_scores`` fixed an issue arising from empty arguments
20+
921
4.4.22 - Jun 13, 2024
1022
_______________________
1123

1224

1325
**Updated**
1426

1527
- Dependencies, updated ``packaging``, ``superannotate-schemas``.
16-
- ``search_folders`` by multiple statuses.
28+
- ``SAClient.search_folders`` by multiple statuses.
1729

1830

1931
4.4.21 - May 23, 2024
@@ -22,8 +34,8 @@ _______________________
2234

2335
**Updated**
2436

25-
- Dependencies, removed ``email-validator``.
26-
- ``add_items_to_subset`` added GenAI projects support.
37+
- Dependencies, removed ``SAClientemail-validator``.
38+
- ``SAClient.add_items_to_subset`` added GenAI projects support.
2739

2840

2941

src/superannotate/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import sys
44

55

6-
__version__ = "4.4.22"
6+
__version__ = "4.4.23b1"
77

88
sys.path.append(os.path.split(os.path.realpath(__file__))[0])
99

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

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1188,10 +1188,22 @@ def prepare_export(
11881188
:type only_pinned: bool
11891189
11901190
:param kwargs:
1191-
Arbitrary kwargs::
1191+
Arbitrary kwargs:
11921192
* integration_name: can be provided which will be used as a storage to store export file
11931193
* format: can be CSV for the Gen AI projects
11941194
1195+
Request Example:
1196+
::
1197+
client = SAClient()
1198+
1199+
export = client.prepare_export(
1200+
project = "Project Name",
1201+
folder_names = ["Folder 1", "Folder 2"],
1202+
annotation_statuses = ["Completed","QualityCheck"],
1203+
export_type = "CSV")
1204+
1205+
client.download_export("Project Name", export, "path_to_download")
1206+
11951207
:return: metadata object of the prepared export
11961208
:rtype: dict
11971209
"""

tests/integration/test_upload_priority_scores.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
import os
22
from pathlib import Path
3-
from unittest import mock
43

54
from src.superannotate import SAClient
65
from tests.integration.base import BaseTestCase
@@ -21,7 +20,10 @@ def folder_path(self):
2120
def test_upload_empty_list(self):
2221
with self.assertLogs("sa", level="INFO") as cm:
2322
sa.upload_priority_scores(self.PROJECT_NAME, scores=[])
24-
assert cm.output[0] == 'INFO:sa:Uploading priority scores for 0 item(s) to TestUploadPriorityScores.'
23+
assert (
24+
cm.output[0]
25+
== "INFO:sa:Uploading priority scores for 0 item(s) to TestUploadPriorityScores."
26+
)
2527

2628
def test_upload_priority_scores(self):
2729

0 commit comments

Comments
 (0)