From 804c48c752dd6e88dd28c6a3638be5f690af60de Mon Sep 17 00:00:00 2001
From: Vaghinak Basentsyan <vaghinak@superannotate.com>
Date: Wed, 19 Apr 2023 11:24:30 +0400
Subject: [PATCH] Docs upadates

---
 docs/source/api_reference/api_folder.rst      |   1 +
 docs/source/index.rst                         | 111 +-----------------
 requirements.txt                              |   6 +-
 .../lib/app/interface/sdk_interface.py        |   2 +-
 4 files changed, 6 insertions(+), 114 deletions(-)

diff --git a/docs/source/api_reference/api_folder.rst b/docs/source/api_reference/api_folder.rst
index d4890066c..916a2121d 100644
--- a/docs/source/api_reference/api_folder.rst
+++ b/docs/source/api_reference/api_folder.rst
@@ -3,6 +3,7 @@ Folders
 =======
 
 .. automethod:: superannotate.SAClient.search_folders
+.. automethod:: superannotate.SAClient.set_folder_status
 .. automethod:: superannotate.SAClient.assign_folder
 .. automethod:: superannotate.SAClient.unassign_folder
 .. automethod:: superannotate.SAClient.get_folder_by_id
diff --git a/docs/source/index.rst b/docs/source/index.rst
index b4d9afc86..c89ca3a6a 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -19,113 +19,4 @@
    History <changelog_link>
    LICENSE.rst
 
-----------
-
-SuperAnnotate Python SDK documentation
-==================================================================
-
-SuperAnnotate Python SDK allows access to the platform without web browser:
-
-.. 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
-____________
-
-
-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.
-
-----------
-
-Supported Features
-__________________
-
-- Search projects
-- Create/delete a project
-- Upload images to a project from a local or AWS S3 folder
-- Upload videos to a project from a local folder
-- Upload annotations/pre-annotations to a project from local or AWS S3 folder
-- Set the annotation status of the images being uploaded
-- Export annotations from a project to a local or AWS S3 folder
-- Share and unshare a project with a team contributor
-- Invite a team contributor
-- Search images in a project
-- Download a single image
-- Copy/move image between projects
-- Get image bytes (e.g., for numpy array creation)
-- Set image annotation status
-- Download image annotations/pre-annotations
-- Create/download project annotation classes
-- Add annotations to images on platform
-- Convert annotation format from/to COCO
-- Add annotations to local SuperAnnotate format JSONs
-- CLI commands for simple tasks
-- Aggregate class/attribute distribution as histogram
-
-----------
-
-License
-_______
-
-This SDK is distributed under the :ref:`MIT License <ref_license>`.
-
-----------
-
-Questions and Issues
-____________________
-
-For questions and issues please use issue tracker on
-`GitHub <https://github.com/superannotateai/superannotate-python-sdk>`_.
+.. include:: ../../README.rst
diff --git a/requirements.txt b/requirements.txt
index e7777454d..6f594e2d3 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -8,17 +8,17 @@ pillow==9.4.0
 matplotlib>=3.3.1
 xmltodict==0.12.0
 opencv-python>=4.4.0.42
-wheel>=0.38.4
+wheel>=0.40.0
 packaging>=20.4
 plotly>=4.1.0
 ffmpeg-python>=0.2.0
 fire==0.4.0
 mixpanel==4.8.3
-pydantic>=1.10.4
+pydantic>=1.10.7
 setuptools>=57.4.0
 email-validator>=1.0.3
 jsonschema==3.2.0
 pandas>=1.1.4
 aiofiles==0.8.0
-Werkzeug==2.2.2
+Werkzeug==2.2.3
 Jinja2==3.1.2
diff --git a/src/superannotate/lib/app/interface/sdk_interface.py b/src/superannotate/lib/app/interface/sdk_interface.py
index f4980b4b3..ad4b4324e 100644
--- a/src/superannotate/lib/app/interface/sdk_interface.py
+++ b/src/superannotate/lib/app/interface/sdk_interface.py
@@ -2192,7 +2192,7 @@ def get_annotations(
         :param project: project name or folder path (e.g., “project1/folder1”).
         :type project: str
 
-        :param items:  item names. If None all items in the project will be exported
+        :param items:  item names. If None all items in specified directory
         :type items: list of strs
 
         :return: list of annotations