Package: pykoala
pykoala=======A server that runs object detection modelsThis Python package is automatically generated by the `SwaggerCodegen <https://github.com/swagger-api/swagger-codegen>`__ project:-  API version: 1.1.0+127-  Package version: 1.1.0+127-  Build package: io.swagger.codegen.languages.PythonClientCodegen Formore information, please visit http://deepcore.ioRequirements.-------------Python 2.7 and 3.4+Installation & Usage--------------------pip install~~~~~~~~~~~If the python package is hosted on Github, you can install directly fromGithub.. code:: shpip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to run ``pip`` with root permission:``sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git``)Then import the package:.. code:: pythonimport pykoalaSetuptools~~~~~~~~~~Install via `Setuptools <http://pypi.python.org/pypi/setuptools>`__... code:: shpython setup.py install --user(or ``sudo python setup.py install`` to install the package for allusers)Then import the package:.. code:: pythonimport pykoalaGetting Started---------------Please follow the `installation procedure <#installation--usage>`__ andthen run the following:.. code:: pythonfrom __future__ import print_functionimport timeimport pykoalafrom pykoala.rest import ApiExceptionfrom pprint import pprint# create an instance of the API classapi_instance = pykoala.ConfigApi()try:# Gets the server configurationapi_instance.get_config()except ApiException as e:print("Exception when calling ConfigApi->get_config: %s\n" % e)Documentation for API Endpoints-------------------------------All URIs are relative to *http://localhost*+---------------+----------------+----------------+----------------+| Class         | Method         | HTTP request   | Description    |+===============+================+================+================+| *ConfigApi*   | `**get\_config | **GET**        | Gets the       ||               | ** <docs/Confi | /config        | server         ||               | gApi.md#get_co |                | configuration  ||               | nfig>`__       |                |                |+---------------+----------------+----------------+----------------+| *ConfigApi*   | `**get\_versio | **GET**        | Gets the       ||               | n** <docs/Conf | /config/versio | server version ||               | igApi.md#get_v | n              | information    ||               | ersion>`__     |                |                |+---------------+----------------+----------------+----------------+| *ConfigApi*   | `**patch\_conf | **PATCH**      | Modify the     ||               | ig** <docs/Con | /config        | server         ||               | figApi.md#patc |                | configuration  ||               | h_config>`__   |                |                |+---------------+----------------+----------------+----------------+| *ConfigApi*   | `**set\_config | **PUT**        | Sets the       ||               | ** <docs/Confi | /config        | server         ||               | gApi.md#set_co |                | configuration  ||               | nfig>`__       |                |                |+---------------+----------------+----------------+----------------+| *JobApi*      | `**delete\_job | **DELETE**     | Remove a job,  ||               | ** <docs/JobAp | /job/{jobId}   | stopping it if ||               | i.md#delete_jo |                | neccessary.    ||               | b>`__          |                |                |+---------------+----------------+----------------+----------------+| *JobApi*      | `**get\_job**  | **GET**        | Get            ||               | <docs/JobApi.m | /job/{jobId}   | information    ||               | d#get_job>`__  |                | about a job    |+---------------+----------------+----------------+----------------+| *JobApi*      | `**get\_job\_s | **GET**        | Get status of  ||               | tatus** <docs/ | /job/{jobId}/s | a job          ||               | JobApi.md#get_ | tatus          |                ||               | job_status>`__ |                |                |+---------------+----------------+----------------+----------------+| *JobApi*      | `**get\_log**  | **GET**        | Get the job    ||               | <docs/JobApi.m | /job/{jobId}/l | log            ||               | d#get_log>`__  | og             |                |+---------------+----------------+----------------+----------------+| *JobApi*      | `**get\_result | **GET**        | Get the        ||               | ** <docs/JobAp | /job/{jobId}/r | detection      ||               | i.md#get_resul | esult          | results        ||               | t>`__          |                |                |+---------------+----------------+----------------+----------------+| *JobApi*      | `**list\_jobs* | **GET** /jobs  | Lists current  ||               | * <docs/JobApi |                | jobs           ||               | .md#list_jobs> |                |                ||               | `__            |                |                |+---------------+----------------+----------------+----------------+| *JobApi*      | `**start\_job* | **POST** /jobs | Create a new   ||               | * <docs/JobApi |                | job            ||               | .md#start_job> |                |                ||               | `__            |                |                |+---------------+----------------+----------------+----------------+| *ModelApi*    | `**add\_model* | **POST**       | Add a new      ||               | * <docs/ModelA | /models        | model          ||               | pi.md#add_mode |                |                ||               | l>`__          |                |                |+---------------+----------------+----------------+----------------+| *ModelApi*    | `**delete\_mod | **DELETE**     | Delete a model ||               | el** <docs/Mod | /model/{modelI |                ||               | elApi.md#delet | d}             |                ||               | e_model>`__    |                |                |+---------------+----------------+----------------+----------------+| *ModelApi*    | `**get\_model* | **GET**        | Get model      ||               | * <docs/ModelA | /model/{modelI | metadata       ||               | pi.md#get_mode | d}             |                ||               | l>`__          |                |                |+---------------+----------------+----------------+----------------+| *ModelApi*    | `**list\_model | **GET**        | Lists          ||               | s** <docs/Mode | /models        | available      ||               | lApi.md#list_m |                | models or add  ||               | odels>`__      |                | new ones       |+---------------+----------------+----------------+----------------+| *RunnerApi*   | `**get\_capaci | **GET**        | Maximum number ||               | ty** <docs/Run | /runners/capac | of runners     ||               | nerApi.md#get_ | ity            |                ||               | capacity>`__   |                |                |+---------------+----------------+----------------+----------------+| *RunnerApi*   | `**get\_log**  | **GET**        | Get the runner ||               | <docs/RunnerAp | /runner/{runne | log            ||               | i.md#get_log>` | rId}/log       |                ||               | __             |                |                |+---------------+----------------+----------------+----------------+| *RunnerApi*   | `**get\_runner | **GET**        | Get status of  ||               | ** <docs/Runne | /runner/{runne | a job runner   ||               | rApi.md#get_ru | rId}           |                ||               | nner>`__       |                |                |+---------------+----------------+----------------+----------------+| *RunnerApi*   | `**list\_runne | **GET**        | Lists job      ||               | rs** <docs/Run | /runners       | runners        ||               | nerApi.md#list |                |                ||               | _runners>`__   |                |                |+---------------+----------------+----------------+----------------+| *RunnerApi*   | `**load\_runne | **POST**       | Load a job     ||               | r** <docs/Runn | /runners       | runner         ||               | erApi.md#load_ |                |                ||               | runner>`__     |                |                |+---------------+----------------+----------------+----------------+| *RunnerApi*   | `**stop\_runne | **DELETE**     | Unload a job   ||               | r** <docs/Runn | /runner/{runne | runner         ||               | erApi.md#stop_ | rId}           |                ||               | runner>`__     |                |                |+---------------+----------------+----------------+----------------+Documentation For Models-------------------------  `ColorMode <docs/ColorMode.md>`__-  `Error <docs/Error.md>`__-  `IdList <docs/IdList.md>`__-  `Image <docs/Image.md>`__-  `InlineResponse200 <docs/InlineResponse200.md>`__-  `JobRequest <docs/JobRequest.md>`__-  `JobStatus <docs/JobStatus.md>`__-  `LabelFilter <docs/LabelFilter.md>`__-  `LatLonBoundingBox <docs/LatLonBoundingBox.md>`__-  `LatLonCoord <docs/LatLonCoord.md>`__-  `Message <docs/Message.md>`__-  `ModelMetadata <docs/ModelMetadata.md>`__-  `Point <docs/Point.md>`__-  `R2PProperties <docs/R2PProperties.md>`__-  `RunnerRequest <docs/RunnerRequest.md>`__-  `RunnerStatus <docs/RunnerStatus.md>`__-  `ServiceVersion <docs/ServiceVersion.md>`__-  `Size <docs/Size.md>`__-  `SizeStep <docs/SizeStep.md>`__-  `Version <docs/Version.md>`__-  `CreatedMessage <docs/CreatedMessage.md>`__-  `DeletedMessage <docs/DeletedMessage.md>`__-  `ImageUrl <docs/ImageUrl.md>`__-  `JobCanceled <docs/JobCanceled.md>`__-  `JobFailed <docs/JobFailed.md>`__-  `JobQueued <docs/JobQueued.md>`__-  `JobRunning <docs/JobRunning.md>`__-  `JobSetup <docs/JobSetup.md>`__-  `JobStarting <docs/JobStarting.md>`__-  `JobSuccessful <docs/JobSuccessful.md>`__-  `JobWaiting <docs/JobWaiting.md>`__-  `RunnerIdle <docs/RunnerIdle.md>`__-  `RunnerRunning <docs/RunnerRunning.md>`__-  `RunnerStarting <docs/RunnerStarting.md>`__-  `RunnerStopping <docs/RunnerStopping.md>`__Documentation For Authorization-------------------------------All endpoints do not require authorization.Author------deepcore-support@digitalglobe.com