Skip to content

Update README.rst #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Feb 17, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 28 additions & 28 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,19 +25,19 @@ _____
Most of these methods will return a `scaleapi.Task` object, which will contain information
about the json response (task_id, status...).

Any parameter available in the documentation\_ can be passed as an argument option with the corresponding type.
Any parameter available in `Scale's API documentation`__ can be passed as an argument option with the corresponding type.

.. \_documentation: https://docs.scale.com/reference#task-object
__ https://docs.scale.com/reference#task-object

The following endpoints for tasks are available:

Create Task
^^^^^^^^^^^

This method can be used for any Scale supported task type using the following format:
`client.create_{{Task Type}}_task(...)` and passing the applicable values into the function definition. The applicable fields and further information for each task type can be found in scales API docs `here`\_\_ for further information.
`client.create_{{Task Type}}_task(...)` and passing the applicable values into the function definition. The applicable fields and further information for each task type can be found in `Scale's API documentation`__.

\_\_ hhttps://docs.scale.com/reference#general-image-annotation
__ https://docs.scale.com/reference#general-image-annotation

.. code-block:: python

Expand All @@ -59,9 +59,9 @@ This method can be used for any Scale supported task type using the following fo
Retrieve task
^^^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#retrieve-tasks
__ https://docs.scale.com/reference#retrieve-tasks

Retrieve a task given its id.

Expand All @@ -74,9 +74,9 @@ Retrieve a task given its id.
List Tasks
^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#list-multiple-tasks
__ https://docs.scale.com/reference#list-multiple-tasks

Retrieve a list of tasks, with optional filter by stand and end date/type. Paginated with `next_token`. The return value is a `scaleapi.Tasklist`, which acts as a list, but also has fields for the total number of tasks, the limit and offset, and whether or not there's more.

Expand Down Expand Up @@ -104,9 +104,9 @@ Retrieve a list of tasks, with optional filter by stand and end date/type. Pagin
Cancel Task
^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#cancel-task
__ https://docs.scale.com/reference#cancel-task

Cancel a task given its id if work has not stared on the task (task status is "que).

Expand All @@ -120,9 +120,9 @@ _______
Create Batch
^^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#batch-creation
__ https://docs.scale.com/reference#batch-creation

.. code-block:: python

Expand All @@ -135,9 +135,9 @@ Check `this`\_\_ for further information.
Finalize Batceh
^^^^^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#batch-finalization
__ https://docs.scale.com/reference#batch-finalization

.. code-block:: python

Expand All @@ -146,9 +146,9 @@ Check `this`\_\_ for further information.
Check Batch Status
^^^^^^^^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#batch-status
__ https://docs.scale.com/reference#batch-status

.. code-block:: python

Expand All @@ -157,9 +157,9 @@ Check `this`\_\_ for further information.
Retrieve Batch
^^^^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#batch-retrieval
__ https://docs.scale.com/reference#batch-retrieval

.. code-block:: python

Expand All @@ -168,9 +168,9 @@ Check `this`\_\_ for further information.
List Batches
^^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#batch-list
__ https://docs.scale.com/reference#batch-list

Retrieve a list of batches

Expand Down Expand Up @@ -198,9 +198,9 @@ ________
Create Project
^^^^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#project-creation
__ https://docs.scale.com/reference#project-creation

.. code-block:: python

Expand All @@ -213,9 +213,9 @@ Check `this`\_\_ for further information.
Retrieve Project
^^^^^^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#project-retrieval
__ https://docs.scale.com/reference#project-retrieval

.. code-block:: python

Expand All @@ -225,9 +225,9 @@ List Projects
^^^^^^^^^^^^^

This function does not take any arguments. It will return information for every project.
Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#batch-list
__ https://docs.scale.com/reference#batch-list

Retrieve a list of batches

Expand All @@ -242,9 +242,9 @@ Retrieve a list of batches
Update Project
^^^^^^^^^^^^^^

Check `this`\_\_ for further information.
Check out `Scale's API documentation`__ for more information.

\_\_ https://docs.scale.com/reference#project-update-parameters
__ https://docs.scale.com/reference#project-update-parameters

Retrieve a list of batches

Expand Down