Merge pull request #532 from superannotateai/develop

Develop

Author: VaghinakDev

CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog 
 All release highlights of this project will be documented in this file.
+
+## 4.4.6 - November 23, 2022
+### Updated
+- `SAClient.aggregate_annotations_as_df` method to aggregate "comment" type instances.
+- `SAClient.add_annotation_bbox_to_image`, `SAClient.add_annotation_point_to_image`, `SAClient.add_annotation_comment_to_image` _methods_ to add deprecation warnings.
+### Fixed
+- Special characters are being encoded after annotation upload (Windows)
+- `SAClient.assign_folder` _method_ to address the invalid argument name.
+- `SAClient.upload_images_from_folder_to_project` _method_ to address uploading of more than 500 items.
+- `SAClient.upload_annotations_from_folder_to_project` _method_ to address the issue of a folder size being more than 25,5 MB.
+- `SAClient.download_image` _method_ to address the KeyError 'id' when `include_annotations` is set to `True`.
+### Removed
+`SAClient.upload_preannotations_from_folder_to_project` _method_
+`SAClient.copy_image` _method_
+###
 ## 4.4.5 - October 23, 2022
 ### Added
 - `SAClient.add_items_to_subset` _method_ to associate given items with a Subset.

README.md

@@ -0,0 +1,128 @@
+SuperAnnotate Python SDK
+===============================
+|Python| |License| |Changelog|
+
+
+Welcome to the SuperAnnotate Python Software Development Kit (SDK), which enables Python programmers to create software that incorporates services of the platform and effortlessly integrates SuperAnnotate into their AI process.
+
+.. |Python| image:: https://img.shields.io/static/v1?label=python&message=3.7/3.8/3.9/3.10/3.11&color=blue&style=flat-square
+    :target: https://pypi.org/project/superannotate/
+    :alt: Python Versions
+.. |License| image:: https://img.shields.io/static/v1?label=license&message=MIT&color=green&style=flat-square
+    :target: https://github.com/superannotateai/superannotate-python-sdk/blob/master/LICENSE/
+    :alt: License
+.. |Changelog| image:: https://img.shields.io/static/v1?label=change&message=log&color=yellow&style=flat-square
+    :target: https://github.com/superannotateai/superannotate-python-sdk/blob/master/CHANGELOG.md
+    :alt: Changelog
+
+Resources
+---------------
+
+- API Reference and User Guide available on `Read the Docs <https://superannotate.readthedocs.io/en/stable/superannotate.sdk.html>`__
+- `Platform documentation <https://doc.superannotate.com/>`__
+
+
+Authentication
+---------------
+
+.. code-block:: python
+
+    >>> from superannotate import SAClient
+        # by environment variable SA_TOKEN
+    >>> sa_client = SAClient()
+        # by token
+    >>> sa_client = SAClient(token='<team token>')
+        # by config file
+        # default path is ~/.superannotate/config.json
+    >>> sa_client = SAClient(config_path='~/.superannotate/dev_config.json')
+
+Using superannotate
+-------------------
+
+.. code-block:: python
+
+    >>> from superannotate import SAClient
+    >>> sa_client =SAClient()
+    >>> project = 'Dogs'
+    >>> sa_client.create_project(
+            project_name=project,
+            project_description='Test project generated via SDK',
+            project_type='Vector'
+        )
+        >>> sa_client.create_annotation_class(
+            project=project,
+            name='dog',
+            color='#F9E0FA',
+            class_type='tag'
+        )
+    >>> sa_client.attach_items(
+            project=project,
+            attachments=[
+                {
+                    'url': 'https://drive.google.com/uc?export=download&id=1ipOrZNSTlPUkI_hnrW9aUD5yULqqq5Vl',
+                    'name': 'dog.jpeg'
+                }
+            ]
+        )
+    >>> sa_client.upload_annotations(
+            project=project,
+            annotations=[
+                {
+                    'metadata': {'name': 'dog.jpeg'},
+                    'instances': [
+                        {'type': 'tag', 'className': 'dog'}
+                    ]
+                }
+            ]
+        )
+    >>> sa_client.get_annotations(project=project, items=['dog.jpeg'])
+
+Installation
+------------
+
+SuperAnnotate python SDK is available on PyPI:
+
+.. code-block:: bash
+
+    pip install superannotate
+
+
+The package officially supports Python 3.7+ and was tested under Linux and
+Windows (`Anaconda <https://www.anaconda.com/products/individual#windows>`__
+) platforms.
+
+For more detailed installation steps and package usage please have a look at the `tutorial <https://superannotate.readthedocs.io/en/stable/tutorial.sdk.html>`__
+
+
+Supported Features
+------------------
+
+- search/get/create/clone/update/delete projects
+- search/get/create/delete folders
+- assign folders to project contributors
+- upload items to a project from a local or AWS S3 folder
+- attach items by URL or from an integrated storage, meanwhile keeping them secure in your cloud provider
+- get integrated cloud storages
+- upload annotations (also from local or AWS S3 folder)
+- delete annotations
+- set items annotations statuses
+- get/download/export annotations from a project (also to a local or AWS S3 folder)
+- invite/search team contributors or add contributors to a specific project
+- search/get/copy/move items in a project
+- query items using SA Query Language
+- define custom metadata for items and upload custom values (query based on your custom metadata)
+- upload priority scores
+- get available subsets (sets of segregated items), query items in a subset or add items to a subset
+- assign or anassign items to project contributors
+- download an image that has been uploaded to project
+- search/create/download/delete project annotation classes
+- search/download models
+- run predictions
+- convert annotations from/to COCO format
+- convert annotation from VOC, SuperVisely, LabelBox, DataLoop, VGG, VoTT, SageMaker, GoogleCloud, YOLO formats
+- CLI commands for simple tasks
+
+Questions and Issues
+--------------------
+
+For questions and issues please use this repo’s issue tracker on GitHub or contact support@superannotate.com.

README.rst

@@ -42,7 +42,6 @@ ________
 .. automethod:: superannotate.SAClient.upload_videos_from_folder_to_project
 .. _ref_upload_annotations_from_folder_to_project:
 .. automethod:: superannotate.SAClient.upload_annotations_from_folder_to_project
-.. automethod:: superannotate.SAClient.upload_preannotations_from_folder_to_project
 .. automethod:: superannotate.SAClient.add_contributors_to_project
 .. automethod:: superannotate.SAClient.get_project_settings
 .. automethod:: superannotate.SAClient.set_project_default_image_quality_in_editor
@@ -107,7 +106,6 @@ ______
 .. automethod:: superannotate.SAClient.download_image
 .. automethod:: superannotate.SAClient.download_image_annotations
 .. automethod:: superannotate.SAClient.upload_image_annotations
-.. automethod:: superannotate.SAClient.copy_image
 .. automethod:: superannotate.SAClient.pin_image
 .. automethod:: superannotate.SAClient.add_annotation_bbox_to_image
 .. automethod:: superannotate.SAClient.add_annotation_point_to_image

docs/source/superannotate.sdk.rst

@@ -17,10 +17,6 @@ def get_version():
 with open("requirements.txt") as f:
     requirements.extend(f.read().splitlines())
 
-with open('README.md') as f:
-    readme = f.read()
-
-readme = "\n".join(readme.split('\n')[2:])
 
 setup(
     name='superannotate',
@@ -31,12 +27,12 @@ def get_version():
     description='Python SDK to SuperAnnotate platform',
     license='MIT',
     author='SuperAnnotate AI',
+    author_email='suppoort@superannotate.com',
     url='https://github.com/superannotateai/superannotate-python-sdk',
-    long_description=readme,
-    long_description_content_type='text/markdown',
+    long_description=open('README.rst').read(),
+    long_description_content_type='text/x-rst',
     install_requires=requirements,
     setup_requires=['wheel'],
-    description_file="README.md",
     entry_points={
         'console_scripts': ['superannotatecli = superannotate.lib.app.bin.superannotate:main']
     },

setup.py

@@ -2,7 +2,7 @@
 import sys
 
 
-__version__ = "4.4.5"
+__version__ = "4.4.6b2"
 
 
 sys.path.append(os.path.split(os.path.realpath(__file__))[0])

src/superannotate/__init__.py

@@ -91,6 +91,7 @@ class DataAggregator:
         "polygon": lambda annotation: annotation["points"],
         "polyline": lambda annotation: annotation["points"],
         "cuboid": lambda annotation: annotation["points"],
+        "comment": lambda annotation: annotation["points"],
         "point": lambda annotation: {"x": annotation["x"], "y": annotation["y"]},
         "annotation_type": lambda annotation: dict(
             cx=annotation["cx"],
@@ -123,7 +124,7 @@ def annotation_suffix(self):
                 self._annotation_suffix = PIXEL_ANNOTATION_POSTFIX
             else:
                 self._annotation_suffix = ATTACHED_VIDEO_ANNOTATION_POSTFIX
-        return self._annotation_suffix
+        return ATTACHED_VIDEO_ANNOTATION_POSTFIX
 
     def get_annotation_paths(self):
         annotations_paths = []
@@ -378,7 +379,7 @@ def __append_annotation(annotation_dict):
 
         for annotation_path in annotations_paths:
             annotation_json = json.load(open(annotation_path))
-            parts = annotation_path.name.split(self.annotation_suffix)
+            parts = Path(annotation_path).name.split(self.annotation_suffix)
             if len(parts) != 2:
                 continue
             image_name = parts[0]
@@ -449,8 +450,8 @@ def __append_annotation(annotation_dict):
                 attributes = annotation.get("attributes")
                 user_metadata = self.__get_user_metadata(annotation)
                 folder_name = None
-                if annotation_path.parent != Path(self.project_root):
-                    folder_name = annotation_path.parent.name
+                if Path(annotation_path).parent != Path(self.project_root):
+                    folder_name = Path(annotation_path).parent.name
                 num_added = 0
                 if not attributes:
                     annotation_dict = {

src/superannotate/lib/app/analytics/aggregators.py

@@ -129,27 +129,6 @@ def export_project(
         )
         sys.exit(0)
 
-    def upload_preannotations(
-        self, project, folder, dataset_name=None, task=None, format=None
-    ):
-        """
-        To upload preannotations from folder to project use
-        Optional argument format accepts input annotation format. It can have COCO or SuperAnnotate values.
-         If the argument is not given then SuperAnnotate (the native annotation format) is assumed.
-        Only when COCO format is specified dataset-name and task arguments are required.
-        dataset-name specifies JSON filename (without extension) in <folder_path>.
-        task specifies the COCO task for conversion. Please see import_annotation_format for more details.
-        """
-        self._upload_annotations(
-            project=project,
-            folder=folder,
-            format=format,
-            dataset_name=dataset_name,
-            task=task,
-            pre=True,
-        )
-        sys.exit(0)
-
     def upload_annotations(
         self, project, folder, dataset_name=None, task=None, format=None
     ):
@@ -167,13 +146,10 @@ def upload_annotations(
             format=format,
             dataset_name=dataset_name,
             task=task,
-            pre=False,
         )
         sys.exit(0)
 
-    def _upload_annotations(
-        self, project, folder, format, dataset_name, task, pre=True
-    ):
+    def _upload_annotations(self, project, folder, format, dataset_name, task):
         project_folder_name = project
         project_name, folder_name = split_project_path(project)
         project = SAClient().controller.get_project(project_name)
@@ -197,14 +173,10 @@ def _upload_annotations(
                     task=task,
                 )
                 annotations_path = temp_dir
-            if pre:
-                SAClient().upload_preannotations_from_folder_to_project(
-                    project_folder_name, annotations_path
-                )
-            else:
-                SAClient().upload_annotations_from_folder_to_project(
-                    project_folder_name, annotations_path
-                )
+
+            SAClient().upload_annotations_from_folder_to_project(
+                project_folder_name, annotations_path
+            )
         sys.exit(0)
 
     def attach_image_urls(