Friday

.github/workflows/release.yml

@@ -2,8 +2,8 @@ name: Publish Python 🐍 distributions 📦 to PyPI and TestPyPI
 
 on:
   release:
-    types: [prereleased,released] 
-    
+    types: [prereleased,released]
+
 jobs:
   build-n-publish:
     name: Build and publish Python 🐍 distributions 📦 to PyPI and TestPyPI
@@ -14,7 +14,7 @@ jobs:
       uses: actions/setup-python@v1
       with:
         python-version: "3.7"
-    - name: Upgrade pip 
+    - name: Upgrade pip
       run: >-
         python -m
         pip install

.pre-commit-config.yaml

@@ -13,7 +13,7 @@ repos:
     hooks:
       - id: black
         name: Code Formatter (black)
-  - repo: 'https://gitlab.com/pycqa/flake8'
+  - repo: 'https://github.com/PyCQA/flake8'
     rev: 3.8.2
     hooks:
       - id: flake8
@@ -30,15 +30,26 @@ repos:
         name: Upgrade syntax for newer versions of the language (pyupgrade)
         args:
           - '--py37-plus'
+  - repo: 'https://github.com/PyCQA/doc8'
+    rev: v1.1.1
+    hooks:
+      - id: doc8
+        name: doc8
+        description: This hook runs doc8 for linting docs
+        entry: python -m doc8
+        language: python
+        args: ['--ignore=D001']
+        files: '^docs(.*)\.rst'
+        require_serial: true
   - repo: 'https://github.com/pre-commit/pre-commit-hooks'
     rev: v3.1.0
     hooks:
       - id: check-byte-order-marker
       - id: trailing-whitespace
       - id: end-of-file-fixer
+        files: \.rst$
 #  - repo: 'https://github.com/asottile/dead'
 #    rev: v1.3.0
 #    hooks:
 #      - id: dead
-files: src/
-exclude: src/lib/app/analytics | src/lib/app/converters | src/lib/app/input_converters
+exclude: src/lib/app/analytics | src/lib/app/input_converters

.readthedocs.yml

@@ -19,7 +19,7 @@ formats:
 
 # Optionally set the version of Python and requirements required to build your docs
 python:
-  version: 3.7
+  version: 3.8
   install:
     - requirements: requirements.txt
     - requirements: requirements_extra.txt

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Changelog 
+# Changelog
 All release highlights of this project will be documented in this file.
 ## 4.4.9 - January 29, 2023
 ### Added
@@ -69,7 +69,7 @@ All release highlights of this project will be documented in this file.
 ## 4.4.2, 4.4.3 - August 21, 2022
 ### Updated
 - the **schema** of `classes JSON` to support new values for the `"group_type"` key for a given attribute group. `"group_type": "radio" | "checklist" | "text" | "numeric"`.
-- the **schema** of `video annotation JSON` to support instances that have a `"tag"` type. 
+- the **schema** of `video annotation JSON` to support instances that have a `"tag"` type.
 ### Fixed
 - `SAClient.get_annotations()` _method_ to address the issue of working with the large projects.
 - `SAClient.get_annotations_per_frame()` _method_ to address the issue of throwing an error on small videos when the fps is set to 1.
@@ -186,7 +186,7 @@ All release highlights of this project will be documented in this file.
 - `attach_items_from_integrated_storage()` to attach items from an integrated cloud storage.
 - `upload_priority_scores()` to set priority scores for a given list of items.
 ### Updated
-- `JSON Schema` to version `1.0.40` to add instance type differentiation for text annotations and `"exclude"` key for subtracted polygon instances for image annotations. 
+- `JSON Schema` to version `1.0.40` to add instance type differentiation for text annotations and `"exclude"` key for subtracted polygon instances for image annotations.
 - `validate_annotations()` to validate text and image annotations based on JSON schema version `1.0.40`.
 - `get_annotations()` to get annotation instances based on JSON schema version `1.0.40`.
 - `prepare_export()` to prepare for the download annotations with based on JSON schema version `1.0.40`.
@@ -206,8 +206,8 @@ All release highlights of this project will be documented in this file.
 ### Updated
 - `get_image_annotations()` to reference `get_annotations()`.
 - `create_annotation_class()` to add `class_type` in parameters to specify class type on creation.
-- `create_annotation_classes_from_classes_json()` to handle class type in classes JSON. 
-- `search_annotation_classes()` to return class type in metadata. 
+- `create_annotation_classes_from_classes_json()` to handle class type in classes JSON.
+- `search_annotation_classes()` to return class type in metadata.
 - `upload_annotations_from_folder_to_project()` to handle tag annotations.
 - `upload_preannotations_from_folder_to_project()` to handle tag annotations.
 - `upload_image_annotations()` to handle tag annotations.
@@ -230,9 +230,9 @@ All release highlights of this project will be documented in this file.
 ### Updated
 - `upload_annotations_from_folder_to_project()` to reference the `validate_annotations()`.
 - `upload_videos_from_folder_to_project()` to remove code duplications.
-- `clone_project()` to set upload state of clone project to inital. 
+- `clone_project()` to set upload state of clone project to inital.
 ### Fixed
-- `validate_annotations()` to fix rotated bounding box schema. 
+- `validate_annotations()` to fix rotated bounding box schema.
 ### Removed
 - Third party logs from logging mechanism.
 ###
@@ -264,22 +264,22 @@ All release highlights of this project will be documented in this file.
 ###
 ## 4.2.6 - Nov 21 2021
 ### Added
-- Validation schemas for annotations. 
+- Validation schemas for annotations.
 - Dataframe aggregation for video projects.
 ### Fixed
-- Minor bug fixes and enhancements.  
+- Minor bug fixes and enhancements.
 ###
 ## 4.2.4 - Nov 2 2021
 ### Fixed
-- Minor bug fixes and enhancements.  
+- Minor bug fixes and enhancements.
 ###
 ## 4.2.3 - Oct 31 2021
 ### Fixed
-- Minor bug fixes and enhancements.  
+- Minor bug fixes and enhancements.
 ###
 ## 4.2.2 - Oct 22 2021
 ### Fixed
-- Minor bug fixes and enhancements.  
+- Minor bug fixes and enhancements.
 ###
 ## 4.2.1 - Oct 13 2021
 ### Fixed
@@ -288,7 +288,7 @@ All release highlights of this project will be documented in this file.
 ###
 ## 4.2.0 - Oct 10 2021
 ### Added
-- `delete_annotations()` for bulk annotation delete. 
+- `delete_annotations()` for bulk annotation delete.
 ### Updated
 - Project/folder limitations.
 ### Fixed
@@ -300,7 +300,7 @@ All release highlights of this project will be documented in this file.
 ### Added
 - Video project release.
 ###
-## 4.1.7 - Aug 1 2021 
+## 4.1.7 - Aug 1 2021
 ### Fixed
 - Video upload refinements.
 ###
@@ -345,7 +345,7 @@ All release highlights of this project will be documented in this file.
 ###
 ## 4.1.0 - Mar 22 2021
 ### Added
-- Folder structure on platform. 
+- Folder structure on platform.
 ###
 ## 4.0.1 - Mar 15 2021
 ### Updated

docs/source/api_reference/api_annotation.rst

@@ -0,0 +1,12 @@
+===========
+Annotations
+===========
+
+.. automethod:: superannotate.SAClient.upload_annotations
+.. automethod:: superannotate.SAClient.get_annotations
+.. automethod:: superannotate.SAClient.download_annotations
+.. automethod:: superannotate.SAClient.get_annotations_per_frame
+.. automethod:: superannotate.SAClient.set_annotation_statuses
+.. automethod:: superannotate.SAClient.delete_annotations
+.. _ref_upload_annotations_from_folder_to_project:
+.. automethod:: superannotate.SAClient.upload_annotations_from_folder_to_project

docs/source/api_reference/api_annotation_class.rst

@@ -0,0 +1,10 @@
+==================
+Annotation Classes
+==================
+
+.. automethod:: superannotate.SAClient.create_annotation_class
+.. _ref_create_annotation_classes_from_classes_json:
+.. automethod:: superannotate.SAClient.create_annotation_classes_from_classes_json
+.. automethod:: superannotate.SAClient.search_annotation_classes
+.. automethod:: superannotate.SAClient.download_annotation_classes_json
+.. automethod:: superannotate.SAClient.delete_annotation_class

docs/source/api_reference/api_client.rst

@@ -0,0 +1,20 @@
+==================
+SAClient interface
+==================
+
+Contents
+========
+
+.. toctree::
+    :maxdepth: 8
+
+    api_project
+    api_item
+    api_annotation
+    api_annotation_class
+    api_export
+    api_custom_metadata
+    api_subset
+    api_image
+    api_team
+    api_neural_network

docs/source/api_reference/api_custom_metadata.rst

@@ -0,0 +1,9 @@
+===============
+Custom Metadata
+===============
+
+.. automethod:: superannotate.SAClient.create_custom_fields
+.. automethod:: superannotate.SAClient.get_custom_fields
+.. automethod:: superannotate.SAClient.delete_custom_fields
+.. automethod:: superannotate.SAClient.upload_custom_values
+.. automethod:: superannotate.SAClient.delete_custom_values

docs/source/api_reference/api_export.rst

@@ -0,0 +1,9 @@
+==========
+Exports
+==========
+
+
+.. automethod:: superannotate.SAClient.prepare_export
+.. _ref_download_export:
+.. automethod:: superannotate.SAClient.download_export
+.. automethod:: superannotate.SAClient.get_exports

docs/source/api_reference/api_image.rst

@@ -0,0 +1,11 @@
+==========
+Images
+==========
+
+
+.. _ref_search_images:
+.. automethod:: superannotate.SAClient.download_image
+.. automethod:: superannotate.SAClient.download_image_annotations
+.. automethod:: superannotate.SAClient.upload_image_annotations
+.. automethod:: superannotate.SAClient.pin_image
+.. automethod:: superannotate.SAClient.upload_priority_scores

docs/source/api_reference/api_item.rst

@@ -0,0 +1,16 @@
+=====
+Items
+=====
+
+
+.. automethod:: superannotate.SAClient.query
+.. automethod:: superannotate.SAClient.get_item_by_id
+.. automethod:: superannotate.SAClient.search_items
+.. automethod:: superannotate.SAClient.attach_items
+.. automethod:: superannotate.SAClient.copy_items
+.. automethod:: superannotate.SAClient.move_items
+.. automethod:: superannotate.SAClient.delete_items
+.. automethod:: superannotate.SAClient.assign_items
+.. automethod:: superannotate.SAClient.unassign_items
+.. automethod:: superannotate.SAClient.get_item_metadata
+.. automethod:: superannotate.SAClient.set_approval_statuses