From e9e73165d9ad27b07f92eb71797b1b60a9ebfe55 Mon Sep 17 00:00:00 2001 From: Vaghinak Basentsyan Date: Thu, 7 Apr 2022 14:31:23 +0400 Subject: [PATCH] Docs versin change --- docs/source/superannotate.sdk.rst | 20 ++++++++++--------- docs/source/tutorial.sdk.rst | 4 ++-- requirements_dev.txt | 3 ++- requirements_extra.txt | 2 +- setup.py | 2 +- .../lib/app/interface/sdk_interface.py | 1 + tests/integration/folders/test_folders.py | 5 +++-- 7 files changed, 21 insertions(+), 16 deletions(-) diff --git a/docs/source/superannotate.sdk.rst b/docs/source/superannotate.sdk.rst index 1301a60db..16771f2e2 100644 --- a/docs/source/superannotate.sdk.rst +++ b/docs/source/superannotate.sdk.rst @@ -152,7 +152,7 @@ Project metadata example: { "name": "Example Project test", "description": "test vector", - "creator_id": "hovnatan@superannotate.com", + "creator_id": "admin@superannotate.com", "updatedAt": "2020-08-31T05:43:43.118Z", "createdAt": "2020-08-31T05:43:43.118Z" "type": "Vector", @@ -174,8 +174,8 @@ Export metadata example: .. code-block:: python { - "name": "Aug 17 2020 15:44 Hovnatan.zip", - "user_id": "hovnatan@gmail.com", + "name": "Aug 17 2020 15:44 First Name.zip", + "user_id": "user@gmail.com", "status": 2, "createdAt": "2020-08-17T11:44:26.000Z", "...": "..." @@ -184,6 +184,7 @@ Export metadata example: ---------- + Integration metadata _______________ @@ -200,6 +201,7 @@ Integration metadata example: ---------- + Item metadata _______________ @@ -217,11 +219,11 @@ Item metadata example: "entropy_value": None, "createdAt": "2022-02-15T20:46:44.000Z", "updatedAt": "2022-02-15T20:46:44.000Z" -} - + } ---------- + Image metadata _______________ @@ -304,10 +306,10 @@ Team contributor metadata example: .. code-block:: python { - "id": "hovnatan@superannotate.com", - "first_name": "Hovnatan", - "last_name": "Karapetyan", - "email": "hovnatan@superannotate.com", + "id": "admin@superannotate.com", + "first_name": "First Name", + "last_name": "Last Name", + "email": "admin@superannotate.com", "user_role": 6 "...": "...", } diff --git a/docs/source/tutorial.sdk.rst b/docs/source/tutorial.sdk.rst index 186d805e8..302842fca 100644 --- a/docs/source/tutorial.sdk.rst +++ b/docs/source/tutorial.sdk.rst @@ -388,7 +388,7 @@ A team contributor can be invited to the team with: .. code-block:: python - sa.invite_contributors_to_team(emails=["hovnatan@superannotate.com"], admin=False) + sa.invite_contributors_to_team(emails=["admin@superannotate.com"], admin=False) This invitation should be accepted by the contributor. After which, to share the @@ -396,7 +396,7 @@ project with the found contributor as an QA: .. code-block:: python - sa.share_project(project, "hovnatan@superannotate.com", user_role="QA") + sa.share_project(project, "admin@superannotate.com", user_role="QA") diff --git a/requirements_dev.txt b/requirements_dev.txt index 1208ad661..1476814ab 100644 --- a/requirements_dev.txt +++ b/requirements_dev.txt @@ -1 +1,2 @@ -superannotate_schemas>=1.0.41dev1 +superannotate_schemas>=1.0.41b1 + diff --git a/requirements_extra.txt b/requirements_extra.txt index 9e3d802fb..a1c1cc2f6 100644 --- a/requirements_extra.txt +++ b/requirements_extra.txt @@ -1,4 +1,4 @@ -Sphinx==3.1.2 +Sphinx==3.5.4 tox==3.24.2 pytest==6.2.4 pytest-xdist==2.3.0 diff --git a/setup.py b/setup.py index 357f33faa..03c70f157 100644 --- a/setup.py +++ b/setup.py @@ -30,7 +30,7 @@ description='Python SDK to SuperAnnotate platform', license='MIT', author='SuperAnnotate AI', - author_email='hovnatan@superannotate.com', + author_email='vaghinak@superannotate.com', url='https://github.com/superannotateai/superannotate-python-sdk', long_description=readme, long_description_content_type='text/markdown', diff --git a/src/superannotate/lib/app/interface/sdk_interface.py b/src/superannotate/lib/app/interface/sdk_interface.py index b12d6bc60..7f75b5da9 100644 --- a/src/superannotate/lib/app/interface/sdk_interface.py +++ b/src/superannotate/lib/app/interface/sdk_interface.py @@ -2970,6 +2970,7 @@ def attach_items_from_integrated_storage( :param folder_path: Points to an exact folder/directory within given storage. If None, items are fetched from the root directory. + :type folder_path: str """ project_name, folder_name = extract_project_folder(project) diff --git a/tests/integration/folders/test_folders.py b/tests/integration/folders/test_folders.py index 8bd6540bf..0094bfd1c 100644 --- a/tests/integration/folders/test_folders.py +++ b/tests/integration/folders/test_folders.py @@ -6,13 +6,14 @@ import src.superannotate as sa from tests.integration.base import BaseTestCase +from tests import DATA_SET_PATH import pytest class TestFolders(BaseTestCase): PROJECT_NAME = "test folders" - TEST_FOLDER_PATH = "data_set/sample_project_vector" + TEST_FOLDER_PATH = "sample_project_vector" PROJECT_DESCRIPTION = "desc" PROJECT_TYPE = "Vector" SPECIAL_CHARS = "/\:*?“<>|" @@ -27,7 +28,7 @@ class TestFolders(BaseTestCase): @property def folder_path(self): - return os.path.join(dirname(dirname(__file__)), self.TEST_FOLDER_PATH) + return os.path.join(DATA_SET_PATH, self.TEST_FOLDER_PATH) @property def classes_json(self):