# unity-sps-ogc-processes-api-python-client
This document is an API definition document provided alongside the OGC API - Processes standard. The OGC API - Processes Standard specifies a processing interface to communicate over a RESTful protocol using JavaScript Object Notation (JSON) encodings. The specification allows for the wrapping of computational tasks into executable processes that can be offered by a server and be invoked by a client application.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.5.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip 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:
```python
import unity_sps_ogc_processes_api_python_client
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import unity_sps_ogc_processes_api_python_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import unity_sps_ogc_processes_api_python_client
from unity_sps_ogc_processes_api_python_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
host = "http://localhost"
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.
# Configure Bearer authorization (JWT): bearerAuth
configuration = unity_sps_ogc_processes_api_python_client.Configuration(
access_token = os.environ["BEARER_TOKEN"]
)
# Enter a context with an instance of the API client
with unity_sps_ogc_processes_api_python_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = unity_sps_ogc_processes_api_python_client.DefaultApi(api_client)
try:
# Information about standards that this API conforms to
api_response = api_instance.conformance_declaration_conformance_get()
print("The response of DefaultApi->conformance_declaration_conformance_get:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling DefaultApi->conformance_declaration_conformance_get: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**conformance_declaration_conformance_get**](docs/DefaultApi.md#conformance_declaration_conformance_get) | **GET** /conformance | Information about standards that this API conforms to
*DefaultApi* | [**deploy_process_processes_post**](docs/DefaultApi.md#deploy_process_processes_post) | **POST** /processes | Deploy a process
*DefaultApi* | [**dismiss_jobs_job_id_delete**](docs/DefaultApi.md#dismiss_jobs_job_id_delete) | **DELETE** /jobs/{job_id} | Cancel a job execution, remove a finished job
*DefaultApi* | [**execute_processes_process_id_execution_post**](docs/DefaultApi.md#execute_processes_process_id_execution_post) | **POST** /processes/{process_id}/execution | Execute a process
*DefaultApi* | [**get_health_health_get**](docs/DefaultApi.md#get_health_health_get) | **GET** /health | Perform a Health Check
*DefaultApi* | [**job_list_jobs_get**](docs/DefaultApi.md#job_list_jobs_get) | **GET** /jobs | Retrieve the list of jobs
*DefaultApi* | [**landing_page_get**](docs/DefaultApi.md#landing_page_get) | **GET** / | Landing page of this API
*DefaultApi* | [**process_description_processes_process_id_get**](docs/DefaultApi.md#process_description_processes_process_id_get) | **GET** /processes/{process_id} | Retrieve a process description
*DefaultApi* | [**process_list_processes_get**](docs/DefaultApi.md#process_list_processes_get) | **GET** /processes | Retrieve the list of available processes
*DefaultApi* | [**results_jobs_job_id_results_get**](docs/DefaultApi.md#results_jobs_job_id_results_get) | **GET** /jobs/{job_id}/results | Retrieve the result(s) of a job
*DefaultApi* | [**status_jobs_job_id_get**](docs/DefaultApi.md#status_jobs_job_id_get) | **GET** /jobs/{job_id} | Retrieve the status of a job
*DefaultApi* | [**undeploy_process_processes_process_id_delete**](docs/DefaultApi.md#undeploy_process_processes_process_id_delete) | **DELETE** /processes/{process_id} | Undeploy a process
## Documentation For Models
- [Bbox](docs/Bbox.md)
- [ConfClasses](docs/ConfClasses.md)
- [Crs](docs/Crs.md)
- [Crs5](docs/Crs5.md)
- [Exception](docs/Exception.md)
- [Execute](docs/Execute.md)
- [HTTPValidationError](docs/HTTPValidationError.md)
- [HealthCheck](docs/HealthCheck.md)
- [InputValueInput](docs/InputValueInput.md)
- [InputValueNoObjectInput](docs/InputValueNoObjectInput.md)
- [InputValueNoObjectOutput](docs/InputValueNoObjectOutput.md)
- [InputValueOutput](docs/InputValueOutput.md)
- [JobControlOptions](docs/JobControlOptions.md)
- [JobList](docs/JobList.md)
- [LandingPage](docs/LandingPage.md)
- [Link](docs/Link.md)
- [Metadata](docs/Metadata.md)
- [Metadata1](docs/Metadata1.md)
- [Metadata2](docs/Metadata2.md)
- [ProcessInput](docs/ProcessInput.md)
- [ProcessList](docs/ProcessList.md)
- [ProcessOutput](docs/ProcessOutput.md)
- [ProcessSummary](docs/ProcessSummary.md)
- [StatusCode](docs/StatusCode.md)
- [StatusInfo](docs/StatusInfo.md)
- [Subscriber](docs/Subscriber.md)
- [ValidationError](docs/ValidationError.md)
- [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)
- [Value](docs/Value.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth
- **Type**: Bearer authentication (JWT)
## Author
Raw data
{
"_id": null,
"home_page": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"name": "unity_sps_ogc_processes_api_python_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Unity Processing API conforming to the OGC API - Processes - Part 1 standard",
"author": "OpenAPI Generator Community",
"author_email": "team@openapitools.org",
"download_url": "https://files.pythonhosted.org/packages/79/b4/ab800aff6f0a93f429ffa78ffa896a75faa6096310e7f8eacbeb3327a05b/unity_sps_ogc_processes_api_python_client-1.0.0.tar.gz",
"platform": null,
"description": "# unity-sps-ogc-processes-api-python-client\nThis document is an API definition document provided alongside the OGC API - Processes standard. The OGC API - Processes Standard specifies a processing interface to communicate over a RESTful protocol using JavaScript Object Notation (JSON) encodings. The specification allows for the wrapping of computational tasks into executable processes that can be offered by a server and be invoked by a client application.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Generator version: 7.5.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport unity_sps_ogc_processes_api_python_client\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport unity_sps_ogc_processes_api_python_client\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport unity_sps_ogc_processes_api_python_client\nfrom unity_sps_ogc_processes_api_python_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to http://localhost\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = unity_sps_ogc_processes_api_python_client.Configuration(\n host = \"http://localhost\"\n)\n\n# The client must configure the authentication and authorization parameters\n# in accordance with the API server security policy.\n# Examples for each auth method are provided below, use the example that\n# satisfies your auth use case.\n\n# Configure Bearer authorization (JWT): bearerAuth\nconfiguration = unity_sps_ogc_processes_api_python_client.Configuration(\n access_token = os.environ[\"BEARER_TOKEN\"]\n)\n\n\n# Enter a context with an instance of the API client\nwith unity_sps_ogc_processes_api_python_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = unity_sps_ogc_processes_api_python_client.DefaultApi(api_client)\n\n try:\n # Information about standards that this API conforms to\n api_response = api_instance.conformance_declaration_conformance_get()\n print(\"The response of DefaultApi->conformance_declaration_conformance_get:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling DefaultApi->conformance_declaration_conformance_get: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**conformance_declaration_conformance_get**](docs/DefaultApi.md#conformance_declaration_conformance_get) | **GET** /conformance | Information about standards that this API conforms to\n*DefaultApi* | [**deploy_process_processes_post**](docs/DefaultApi.md#deploy_process_processes_post) | **POST** /processes | Deploy a process\n*DefaultApi* | [**dismiss_jobs_job_id_delete**](docs/DefaultApi.md#dismiss_jobs_job_id_delete) | **DELETE** /jobs/{job_id} | Cancel a job execution, remove a finished job\n*DefaultApi* | [**execute_processes_process_id_execution_post**](docs/DefaultApi.md#execute_processes_process_id_execution_post) | **POST** /processes/{process_id}/execution | Execute a process\n*DefaultApi* | [**get_health_health_get**](docs/DefaultApi.md#get_health_health_get) | **GET** /health | Perform a Health Check\n*DefaultApi* | [**job_list_jobs_get**](docs/DefaultApi.md#job_list_jobs_get) | **GET** /jobs | Retrieve the list of jobs\n*DefaultApi* | [**landing_page_get**](docs/DefaultApi.md#landing_page_get) | **GET** / | Landing page of this API\n*DefaultApi* | [**process_description_processes_process_id_get**](docs/DefaultApi.md#process_description_processes_process_id_get) | **GET** /processes/{process_id} | Retrieve a process description\n*DefaultApi* | [**process_list_processes_get**](docs/DefaultApi.md#process_list_processes_get) | **GET** /processes | Retrieve the list of available processes\n*DefaultApi* | [**results_jobs_job_id_results_get**](docs/DefaultApi.md#results_jobs_job_id_results_get) | **GET** /jobs/{job_id}/results | Retrieve the result(s) of a job\n*DefaultApi* | [**status_jobs_job_id_get**](docs/DefaultApi.md#status_jobs_job_id_get) | **GET** /jobs/{job_id} | Retrieve the status of a job\n*DefaultApi* | [**undeploy_process_processes_process_id_delete**](docs/DefaultApi.md#undeploy_process_processes_process_id_delete) | **DELETE** /processes/{process_id} | Undeploy a process\n\n\n## Documentation For Models\n\n - [Bbox](docs/Bbox.md)\n - [ConfClasses](docs/ConfClasses.md)\n - [Crs](docs/Crs.md)\n - [Crs5](docs/Crs5.md)\n - [Exception](docs/Exception.md)\n - [Execute](docs/Execute.md)\n - [HTTPValidationError](docs/HTTPValidationError.md)\n - [HealthCheck](docs/HealthCheck.md)\n - [InputValueInput](docs/InputValueInput.md)\n - [InputValueNoObjectInput](docs/InputValueNoObjectInput.md)\n - [InputValueNoObjectOutput](docs/InputValueNoObjectOutput.md)\n - [InputValueOutput](docs/InputValueOutput.md)\n - [JobControlOptions](docs/JobControlOptions.md)\n - [JobList](docs/JobList.md)\n - [LandingPage](docs/LandingPage.md)\n - [Link](docs/Link.md)\n - [Metadata](docs/Metadata.md)\n - [Metadata1](docs/Metadata1.md)\n - [Metadata2](docs/Metadata2.md)\n - [ProcessInput](docs/ProcessInput.md)\n - [ProcessList](docs/ProcessList.md)\n - [ProcessOutput](docs/ProcessOutput.md)\n - [ProcessSummary](docs/ProcessSummary.md)\n - [StatusCode](docs/StatusCode.md)\n - [StatusInfo](docs/StatusInfo.md)\n - [Subscriber](docs/Subscriber.md)\n - [ValidationError](docs/ValidationError.md)\n - [ValidationErrorLocInner](docs/ValidationErrorLocInner.md)\n - [Value](docs/Value.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"bearerAuth\"></a>\n### bearerAuth\n\n- **Type**: Bearer authentication (JWT)\n\n\n## Author\n",
"bugtrack_url": null,
"license": "NoLicense",
"summary": "Unity Processing API conforming to the OGC API - Processes - Part 1 standard",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://github.com/GIT_USER_ID/GIT_REPO_ID",
"Repository": "https://github.com/GIT_USER_ID/GIT_REPO_ID"
},
"split_keywords": [
"openapi",
" openapi-generator",
" unity processing api conforming to the ogc api - processes - part 1 standard"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7671f63b462d9963474d04423c07fb02a45c1f05671339b091920949045d4de4",
"md5": "8b0965a6f1346ab0adb82b469648c636",
"sha256": "a95e3c73e41f1e220efb4f1dfca8eb92001224f04f0dc7afb87319a6516dd0b9"
},
"downloads": -1,
"filename": "unity_sps_ogc_processes_api_python_client-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8b0965a6f1346ab0adb82b469648c636",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 88877,
"upload_time": "2024-07-08T20:31:03",
"upload_time_iso_8601": "2024-07-08T20:31:03.308463Z",
"url": "https://files.pythonhosted.org/packages/76/71/f63b462d9963474d04423c07fb02a45c1f05671339b091920949045d4de4/unity_sps_ogc_processes_api_python_client-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "79b4ab800aff6f0a93f429ffa78ffa896a75faa6096310e7f8eacbeb3327a05b",
"md5": "e8fdecaa6bd74f1c5a5a684658ac2eee",
"sha256": "a7b330a96eedd67fafde89c35d56589a7f6d20c0c87a9182929c687b8ef5654b"
},
"downloads": -1,
"filename": "unity_sps_ogc_processes_api_python_client-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "e8fdecaa6bd74f1c5a5a684658ac2eee",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 39563,
"upload_time": "2024-07-08T20:31:05",
"upload_time_iso_8601": "2024-07-08T20:31:05.014586Z",
"url": "https://files.pythonhosted.org/packages/79/b4/ab800aff6f0a93f429ffa78ffa896a75faa6096310e7f8eacbeb3327a05b/unity_sps_ogc_processes_api_python_client-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 20:31:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "GIT_USER_ID",
"github_project": "GIT_REPO_ID",
"github_not_found": true,
"lcname": "unity_sps_ogc_processes_api_python_client"
}
JSON
