Docs update

Author: VaghinakDev

docs/source/index.rst

@@ -30,7 +30,7 @@ SuperAnnotate Python SDK allows access to the platform without web browser:
     from superannotate import SAClient
 
 
-    sa_client =SAClient()
+    sa_client = SAClient()
 
     project = 'Dogs'
 

docs/source/userguide/quickstart.rst

@@ -48,26 +48,27 @@ To generate a default location (:file:`~/.superannotate/config.json`) config fil
 
     ~/(home directory)
     └── .superannotate
-        ├── config.json
+        ├── config.ini
 
 
 :ref:`CLI init <ref_cli_init>` can be used:
 
 .. code-block:: bash
 
-   superannotatecli init
+   superannotatecli init <token>
 
 Custom config file
 ~~~~~~~~~~~~~~~~~~~~~~
 .. _ref_custom_config_file:
 
-To create a custom config file a new JSON file with key "token" can be created:
+To create a custom config file a new INI file with key "token" can be created:
 
-.. code-block:: json
+.. code-block:: ini
 
-   {
-     "token" : "<team token>"
-   }
+    [DEFAULT]
+    SA_TOKEN = <token>
+    LOGGING_LEVEL = INFO
+    LOGGING_PATH = ~/.superannotate/logs
 
 
 Initialization and authorization
@@ -84,7 +85,7 @@ the :ref:`CLI init <ref_cli_init>`. Otherwise to authenticate SDK with the :ref:
 
 .. code-block:: python
 
-   sa = SAClient(config_path="<path_to_config_json>")
+   sa = SAClient(config_path="<path_to_config_file>")
 
 
 

docs/source/userguide/setup_project.rst

@@ -103,19 +103,26 @@ The SuperAnnotate format annotation JSONs have the general form:
 
   {
     "metadata": {...}
-    "annotations": [
+    "instances": [
         {
-          "className": "Human",
-          "points" : "...",
-          "..." : "..."
+          "type": "polygon",
+          "className": "Jake",
+          "points" : [...],
+          ...
         },
         {
-          "className": "Cat",
-          "points" : "...",
-          "..." : "..."
+          "type": "bbox",
+          "className": "Finn",
+          "points": {
+            "x1": 437.16,
+            "x2": 465.23,
+            "y1": 341.5,
+            "y2": 357.09
+          },
+          ...
         },
         {
-          "..." : "..."
+          ...
         }
     ]
 
@@ -125,16 +132,15 @@ the "className" fields here will identify the annotation class of an annotation
 object (polygon, points, etc.). The project
 you are uploading to should contain annotation class with that name.
 
-To upload annotations to platform:
+:ref:`To upload annotations to platform: <ref_upload_annotations_from_folder_to_project>`
 
 .. code-block:: python
 
     sa.upload_annotations_from_folder_to_project(project, "<path_to_local_dir>")
 
-This will try uploading to the project all the JSON files in the folder that have specific
-file naming convention. For vector
-projects JSONs should be named :file:`"<image_name>___objects.json"`. For pixel projects
-JSON files should be named :file:`"<image_name>___pixel.json"` and also for
+
+This will try uploading to the project all the JSON files in the folder that have :file:`"<image_name>.json"` postfix.
+For pixel projects JSON files should be named :file:`"<image_name>___pixel.json"` and also for
 each JSON a mask image file should be present with the name
 :file:`"<image_name>___save.png"`. Image with :file:`<image_name>` should
 already be present in the project for the upload to work.

pytest.ini

@@ -3,5 +3,5 @@ minversion = 3.7
 log_cli=true
 python_files = test_*.py
 pytest_plugins = ['pytest_profiling']
-addopts = -n auto --dist=loadscope
+;addopts = -n auto --dist=loadscope