Metadata-Version: 2.4
Name: ogc-api-processes-client
Version: 0.5.0
Summary: Autogenerated API client conforming to the OGC API - Processes
Project-URL: Repository, https://github.com/EOEPCA/ogc-api-processes-client
Author-email: Fabrice Brito <info@terradue.com>, Simone Tripodi <info@terradue.com>, Frank Loeschau <info@terradue.com>
License-Expression: EUPL-1.0
License-File: LICENSE
Keywords: A sample autogenerated API client conforming to the OGC Processes API,OGC,OpenAPI,OpenAPI-Generator
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.10
Requires-Dist: pydantic>=2
Requires-Dist: pystac>=1.13.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: typing-extensions>=4.7.1
Requires-Dist: urllib3<3.0.0,>=1.25.3
Description-Content-Type: text/markdown

# ogc-api
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.12.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.ogc.org/contacts](https://www.ogc.org/contacts)

## Requirements.

Python 3.8+

## 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 ogc_api_processes_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 ogc_api_processes_client
```

### Tests

Execute `task test` (or `hatch run test:run`) to run the tests.

## Development Tasks

Use Taskfile targets for local development:

- `task build-safe`: regenerate code, apply post-generation fixes, run lint checks, and run tests
- `task check`: run Ruff checks with auto-fix
- `task lint`: format with Ruff
- `task test`: run the test suite

## Code Generation Caveats

Code generation can overwrite repository files if run directly via OpenAPI Generator.

- Prefer `task build-safe` instead of raw generation commands.
- The low-level `build` task is internal and is orchestrated by `build-safe`.
- `.openapi-generator-ignore` protects project-maintained files (`pyproject.toml`, CI workflows, etc.); keep it up to date.
- `build-safe` includes deterministic post-generation fixes (including the known `bytearray`/`pydantic>=2` incompatibility), then runs `check` and `test`.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import ogc_api_processes_client
from ogc_api_processes_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://example.org/ogc
# See configuration.py for a list of all supported configuration parameters.
configuration = ogc_api_processes_client.Configuration(
    host = "http://example.org/ogc"
)



# Enter a context with an instance of the API client
with ogc_api_processes_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ogc_api_processes_client.CapabilitiesApi(api_client)

    try:
        # landing page of this API
        api_response = api_instance.get_landing_page()
        print("The response of CapabilitiesApi->get_landing_page:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CapabilitiesApi->get_landing_page: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://example.org/ogc*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CapabilitiesApi* | [**get_landing_page**](docs/CapabilitiesApi.md#get_landing_page) | **GET** / | landing page of this API
*ConformanceDeclarationApi* | [**get_conformance_classes**](docs/ConformanceDeclarationApi.md#get_conformance_classes) | **GET** /conformance | information about standards that this API conforms to
*DismissApi* | [**dismiss**](docs/DismissApi.md#dismiss) | **DELETE** /jobs/{jobId} | cancel a job execution, remove a finished job
*ExecuteApi* | [**execute**](docs/ExecuteApi.md#execute) | **POST** /processes/{processID}/execution | execute a process.
*JobListApi* | [**get_jobs**](docs/JobListApi.md#get_jobs) | **GET** /jobs | retrieve the list of jobs.
*ProcessDescriptionApi* | [**get_process_description**](docs/ProcessDescriptionApi.md#get_process_description) | **GET** /processes/{processID} | retrieve a process description
*ProcessListApi* | [**get_processes**](docs/ProcessListApi.md#get_processes) | **GET** /processes | retrieve the list of available processes
*ResultApi* | [**get_result**](docs/ResultApi.md#get_result) | **GET** /jobs/{jobId}/results | retrieve the result(s) of a job
*StatusApi* | [**get_status**](docs/StatusApi.md#get_status) | **GET** /jobs/{jobId} | retrieve the status of a job


## Documentation For Models

 - [AdditionalParameter](docs/AdditionalParameter.md)
 - [AdditionalParameterValueInner](docs/AdditionalParameterValueInner.md)
 - [Bbox](docs/Bbox.md)
 - [ConfClasses](docs/ConfClasses.md)
 - [DescriptionType](docs/DescriptionType.md)
 - [DescriptionTypeAdditionalParameters](docs/DescriptionTypeAdditionalParameters.md)
 - [Exception](docs/Exception.md)
 - [Execute](docs/Execute.md)
 - [Execute200Response](docs/Execute200Response.md)
 - [ExecuteInputsValue](docs/ExecuteInputsValue.md)
 - [Format](docs/Format.md)
 - [FormatSchema](docs/FormatSchema.md)
 - [InlineOrRefData](docs/InlineOrRefData.md)
 - [InputDescription](docs/InputDescription.md)
 - [InputDescriptionAllOfMaxOccurs](docs/InputDescriptionAllOfMaxOccurs.md)
 - [InputValue](docs/InputValue.md)
 - [InputValueNoObject](docs/InputValueNoObject.md)
 - [JobControlOptions](docs/JobControlOptions.md)
 - [JobList](docs/JobList.md)
 - [LandingPage](docs/LandingPage.md)
 - [Link](docs/Link.md)
 - [Metadata](docs/Metadata.md)
 - [ModelSchema](docs/ModelSchema.md)
 - [Output](docs/Output.md)
 - [OutputDescription](docs/OutputDescription.md)
 - [Process](docs/Process.md)
 - [ProcessList](docs/ProcessList.md)
 - [ProcessSummary](docs/ProcessSummary.md)
 - [QualifiedInputValue](docs/QualifiedInputValue.md)
 - [Reference](docs/Reference.md)
 - [SchemaOneOf](docs/SchemaOneOf.md)
 - [SchemaOneOfAdditionalProperties](docs/SchemaOneOfAdditionalProperties.md)
 - [SchemaOneOfNot](docs/SchemaOneOfNot.md)
 - [StatusCode](docs/StatusCode.md)
 - [StatusInfo](docs/StatusInfo.md)
 - [Subscriber](docs/Subscriber.md)
 - [TransmissionMode](docs/TransmissionMode.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization

Endpoints do not require authorization.


## Author

standards-team@ogc.org
