Merge pull request #50 from SreeHarshaNelaturu/folder_annotations_fix

Added method to export tags

Author: vmanilo

remo/api.py

@@ -358,25 +358,26 @@ def get_annotation_set(self, id):
         return self.get(url).json()
 
     def export_annotations(
-        self, annotation_set_id: int, annotation_format='json', export_coordinates='pixel', full_path='true'
+        self, annotation_set_id: int, annotation_format='json', export_coordinates='pixel', full_path=True, export_tags: bool = True,
     ) -> bytes:
         """
         Exports annotations in given format
 
         Args:
             annotation_set_id: annotation set id
             annotation_format: can be one of ['json', 'coco', 'csv'], default='json'
-            full_path: uses full image path (e.g. local path), can be one of ['true', 'false'], default='false'
+            full_path: uses full image path (e.g. local path),  it can be one of [True, False], default=True
             export_coordinates: converts output values to percentage or pixels, can be one of ['pixel', 'percent'], default='pixel'
-
+            export_tags: exports the tags to a CSV file, it can be one of [True, False], default=True
         Returns:
             annotation file content
         """
         url = self.url(
             backend.v1_export_annotations.format(annotation_set_id),
             annotation_format=annotation_format,
             export_coordinates=export_coordinates,
-            full_path=full_path,
+            full_path=str(full_path).lower(),
+            export_tags=str(export_tags).lower()
         )
         return self.get(url).content
 

remo/domain/annotation_set.py

@@ -115,16 +115,16 @@ def add_image_annotation(self, image_id: int, annotation: Annotation):
         self.sdk.add_annotation(self.id, image_id, annotation)
 
     def export_annotations(
-        self, annotation_format: str = 'json', export_coordinates: str = 'pixel', full_path: str = 'true'
+        self, annotation_format: str = 'json', export_coordinates: str = 'pixel', full_path: bool = True, export_tags: bool = True
     ):
         """
         Exports annotations in a given format
 
         Args:
             annotation_format: choose format from this list ['json', 'coco', 'csv']
-            full_path: uses full image path (e.g. local path), can be one of ['true', 'false'], default='false'
+            full_path: uses full image path (e.g. local path),  it can be one of [True, False], default=True
             export_coordinates: converts output values to percentage or pixels, can be one of ['pixel', 'percent'], default='pixel'
-
+            export_tags: exports the tags to a CSV file, it can be one of [True, False], default=True
         Returns:
             annotation file content
         """
@@ -133,30 +133,34 @@ def export_annotations(
             annotation_format=annotation_format,
             export_coordinates=export_coordinates,
             full_path=full_path,
+            export_tags=export_tags
         )
 
     def export_annotations_to_file(
         self,
         output_file: str,
         annotation_format: str = 'json',
         export_coordinates: str = 'pixel',
-        full_path: str = 'true',
+        full_path: bool = True,
+        export_tags: bool = True
     ):
         """
         Exports annotations in given format and save to output file
 
         Args:
             output_file: output file to save
             annotation_format: can be one of ['json', 'coco', 'csv'], default='json'
-            full_path: uses full image path (e.g. local path), can be one of ['true', 'false'], default='false'
+            full_path: uses full image path (e.g. local path),  it can be one of [True, False], default=True
             export_coordinates: converts output values to percentage or pixels, can be one of ['pixel', 'percent'], default='pixel'
+            export_tags: exports the tags to a CSV file, it can be one of [True, False], default=True
         """
         self.sdk.export_annotations_to_file(
             output_file,
             self.id,
             annotation_format=annotation_format,
             full_path=full_path,
             export_coordinates=export_coordinates,
+            export_tags=export_tags
         )
 
     def classes(self) -> List[str]:

remo/domain/dataset.py

@@ -240,7 +240,8 @@ def export_annotations(
         annotation_set_id: int = None,
         annotation_format: str = 'json',
         export_coordinates: str = 'pixel',
-        full_path: str = 'true',
+        full_path: bool = True,
+        export_tags: bool = True
     ) -> bytes:
         """
         Export annotations for a given annotation set
@@ -249,8 +250,9 @@ def export_annotations(
             annotation_set_id: annotation set id, by default will be used default_annotation_set
             annotation_format: can be one of ['json', 'coco', 'csv'], default='json'
             export_coordinates: converts output values to percentage or pixels, can be one of ['pixel', 'percent'], default='pixel'
-            full_path: uses full image path (e.g. local path), can be one of ['true', 'false'], default='false'
-
+            full_path: uses full image path (e.g. local path),  it can be one of [True, False], default=True
+            export_tags: exports the tags to a CSV file, it can be one of [True, False], default=True
+            
         Returns:
             annotation file content
         """
@@ -260,6 +262,7 @@ def export_annotations(
                 annotation_format=annotation_format,
                 export_coordinates=export_coordinates,
                 full_path=full_path,
+                export_tags=export_tags
             )
 
         print('ERROR: annotation set not defined')
@@ -270,7 +273,8 @@ def export_annotations_to_file(
         annotation_set_id: int = None,
         annotation_format: str = 'json',
         export_coordinates: str = 'pixel',
-        full_path: str = 'true',
+        full_path: bool = True,
+        export_tags: bool = True
     ):
         """
         Exports annotations in given format and save to output file
@@ -279,8 +283,9 @@ def export_annotations_to_file(
             output_file: output file to save
             annotation_set_id: annotation set id
             annotation_format: can be one of ['json', 'coco', 'csv'], default='json'
-            full_path: uses full image path (e.g. local path), can be one of ['true', 'false'], default='false'
+            full_path: uses full image path (e.g. local path),  it can be one of [True, False], default=True
             export_coordinates: converts output values to percentage or pixels, can be one of ['pixel', 'percent'], default='pixel'
+            export_tags: exports the tags to a CSV file, it can be one of [True, False], default=True
         """
         annotation_set = self.get_annotation_set(annotation_set_id)
         if annotation_set:
@@ -290,6 +295,7 @@ def export_annotations_to_file(
                 annotation_format=annotation_format,
                 full_path=full_path,
                 export_coordinates=export_coordinates,
+                export_tags=export_tags
             )
         else:
             print('ERROR: annotation set not defined')

remo/sdk.py

@@ -394,17 +394,18 @@ def export_annotations(
         annotation_set_id: int,
         annotation_format: str = 'json',
         export_coordinates: str = 'pixel',
-        full_path: str = 'true',
+        full_path: bool = True,
+        export_tags : bool = True
     ) -> bytes:
         """
         Exports annotations in given format
 
         Args:
             annotation_set_id: annotation set id
             annotation_format: can be one of ['json', 'coco', 'csv'], default='json'
-            full_path: uses full image path (e.g. local path), can be one of ['true', 'false'], default='false'
+            full_path: uses full image path (e.g. local path),  it can be one of [True, False], default=True
             export_coordinates: converts output values to percentage or pixels, can be one of ['pixel', 'percent'], default='pixel'
-
+            export_tags: exports the tags to a CSV file, it can be one of [True, False], default=True
         Returns:
             annotation file content
         """
@@ -413,6 +414,7 @@ def export_annotations(
             annotation_format=annotation_format,
             export_coordinates=export_coordinates,
             full_path=full_path,
+            export_tags=export_tags
         )
 
     def export_annotations_to_file(
@@ -421,7 +423,8 @@ def export_annotations_to_file(
         annotation_set_id: int,
         annotation_format: str = 'json',
         export_coordinates: str = 'pixel',
-        full_path: str = 'true',
+        full_path: bool = True,
+        export_tags: bool = True
     ):
         """
         Exports annotations in given format
@@ -430,14 +433,16 @@ def export_annotations_to_file(
             output_file: output file to save
             annotation_set_id: annotation set id
             annotation_format: can be one of ['json', 'coco', 'csv'], default='json'
-            full_path: uses full image path (e.g. local path), can be one of ['true', 'false'], default='false'
+            full_path: uses full image path (e.g. local path),  it can be one of [True, False], default=True
             export_coordinates: converts output values to percentage or pixels, can be one of ['pixel', 'percent'], default='pixel'
+            export_tags: exports the tags to a CSV file, it can be one of [True, False], default=True
         """
         content = self.export_annotations(
             annotation_set_id,
             annotation_format=annotation_format,
             export_coordinates=export_coordinates,
             full_path=full_path,
+            export_tags=export_tags
         )
         self._save_to_file(content, output_file)