Merge pull request #565 from superannotateai/docs_update

docs update quickstart page

Author: nareksa

docs/source/cli_client.rst

@@ -10,14 +10,6 @@ With SuperAnnotate CLI, basic tasks can be accomplished using shell commands:
 
    superannotatecli <command> <--arg1 val1> <--arg2 val2> [--optional_arg3 val3] [--optional_arg4] ...
 
-To use the CLI a command line initialization step should be performed after the
-
-:ref:`installation <ref_quickstart>`:
-
-.. code-block:: bash
-
-   superannotatecli init
-
 ----------
 
 
@@ -34,7 +26,9 @@ To initialize CLI (and SDK) with team token:
 
 .. code-block:: bash
 
-   superannotatecli init
+   superannotatecli init --token <token>
+                         [--logging_level <NOTSET/INFO/DEBUG/WARNING/ERROR/CRITICAL (Default=INFO)>]
+                         [--logging_path <Default=/Users/username/.superannotate/logs>]
 
 ----------
 
@@ -152,7 +146,7 @@ To upload preannotations from folder to project use:
    superannotatecli upload-preannotations --project <project_name> --folder <folder_path>
                                           [--format "COCO" or "SuperAnnotate"]
                                           [--dataset-name "<dataset_name_for_COCO_projects>"]
-                                          [--task "<task_type_for_COCO_projects>]
+                                          [--task "<task_type_for_COCO_projects>"]
 
 
 Optional argument *format* accepts input annotation format. It can have COCO or SuperAnnotate values.
@@ -180,7 +174,7 @@ To upload annotations from folder to project use:
    superannotatecli upload-annotations --project <project_name> --folder <folder_path>
                                        [--format "COCO" or "SuperAnnotate"]
                                        [--dataset-name "<dataset_name_for_COCO_projects>"]
-                                       [--task "<task_type_for_COCO_projects>]
+                                       [--task "<task_type_for_COCO_projects>"]
 
 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.

docs/source/userguide/quickstart.rst

@@ -32,64 +32,71 @@ beforehand. The package works well only under the Anaconda distribution with:
 
    conda install shapely
 
-
 ----------
 
+
 Initialization and authorization
 ================================
 
-Config file
-~~~~~~~~~~~
-
 To use the SDK, you need to create a config file with a team-specific authentication token. The token is available
 to team admins on the team settings page at https://app.superannotate.com/team.
 
-Default location config file
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+SAClient can be used with or without arguments
+______________________________________________
 
-To generate a default location (:file:`~/.superannotate/config.json`) config file::
+**Without arguments**
 
-    ~/(home directory)
-    └── .superannotate
-        ├── config.ini
+.. code-block:: python
 
+   from superannotate import SAClient
 
-:ref:`CLI init <ref_cli_init>` can be used:
 
-.. code-block:: bash
+   sa_client = SAClient()
 
-   superannotatecli init <token>
+*Method 1:* SA_TOKEN is defined as an environment variable.
 
-Custom config file
-~~~~~~~~~~~~~~~~~~
-.. _ref_custom_config_file:
+*Method 2:* Generate a default location (~/.superannotate/config.ini) config file. :ref:`CLI init <ref_cli_init>` should be used:
 
-To create a custom config file a new INI file with key "token" can be created:
+.. code-block:: bash
 
-.. code-block:: ini
+   superannotatecli init --token <token>
+                         [--logging_level <NOTSET/INFO/DEBUG/WARNING/ERROR/CRITICAL (Default=INFO)>]
+                         [--logging_path <Default=/Users/username/.superannotate/logs>]
 
-    [DEFAULT]
-    SA_TOKEN = <token>
-    LOGGING_LEVEL = INFO
-    LOGGING_PATH = ~/.superannotate/logs
 
+**Arguments provided**
 
-Include the package in your Python code:
+*Method 1:* Use the token as an argument:
 
 .. code-block:: python
 
    from superannotate import SAClient
 
-SDK is ready to be used if default location config file was created using
-the :ref:`CLI init <ref_cli_init>`. Otherwise to authenticate SDK with the :ref:`custom config file <ref_custom_config_file>`:
+
+   SAClient(token="<token>")
+
+
+*Method 2:* Create a custom config file:
 
 .. code-block:: python
 
-   sa = SAClient(config_path="<path_to_config_file>")
+   from superannotate import SAClient
+
+
+   sa_client = SAClient(config_path="~/.superannotate/dev-config.ini")
+
+
+Custom config.ini example:
 
+.. code-block:: ini
+
+    [DEFAULT]
+    SA_TOKEN = <token>
+    LOGGING_LEVEL = DEBUG
+    LOGGING_PATH = /Users/username/data/superannotate_logs
 
+----------
 
-.. _basic-use:
 
 Creating a project
 ==================
@@ -103,6 +110,8 @@ To create a new "Vector" project with name "Example Project 1" and description
 
     sa.create_project(project, "test", "Vector")
 
+----------
+
 
 Uploading images to project
 ===========================
@@ -129,6 +138,8 @@ See the full argument options for
    If project name is used it should be unique in team's project list. Using project metadata will give
    performance improvement.
 
+----------
+
 
 Working with images
 ===================
@@ -154,7 +165,7 @@ Upload back to the platform with:
 
    sa.upload_image_annotations(project, image, "<path_to_json>")
 
-
+---------
 
 
 Working with team contributors