# opthub-api-client
OptHub Public REST API.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 0.3.0
- Package version: 0.3.0
- Generator version: 7.8.0-SNAPSHOT
- 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/opthub-org/opthub-api-client-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/opthub-org/opthub-api-client-python.git`)
Then import the package:
```python
import opthub_api_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 opthub_api_client
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import opthub_api_client
from opthub_api_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.opthub.ai
# See configuration.py for a list of all supported configuration parameters.
configuration = opthub_api_client.Configuration(
host = "https://api.opthub.ai"
)
# 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 API key authorization: ApiKeyAuth
configuration.api_key['ApiKeyAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with opthub_api_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = opthub_api_client.MatchTrialsApi(api_client)
match_uuid = '5d7fc778-3e59-4128-a797-2e423c0aa461' # str | Match UUID
create_match_trial_request = opthub_api_client.CreateMatchTrialRequest() # CreateMatchTrialRequest | (optional)
try:
# Create a match trial
api_response = api_instance.create_match_trial(match_uuid, create_match_trial_request=create_match_trial_request)
print("The response of MatchTrialsApi->create_match_trial:\n")
pprint(api_response)
except ApiException as e:
print("Exception when calling MatchTrialsApi->create_match_trial: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.opthub.ai*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*MatchTrialsApi* | [**create_match_trial**](docs/MatchTrialsApi.md#create_match_trial) | **POST** /matches/{match_uuid}/trials | Create a match trial
*MatchTrialsApi* | [**get_match_evaluation**](docs/MatchTrialsApi.md#get_match_evaluation) | **GET** /matches/{match_uuid}/trials/{trial_no}/evaluation | Retrieve status of a specific match evaluation related to the Solution submitted by the Participant themselves.
*MatchTrialsApi* | [**get_match_score**](docs/MatchTrialsApi.md#get_match_score) | **GET** /matches/{match_uuid}/trials/{trial_no}/score | Retrieve status of a specific match score related to the Solution submitted by the Participant themselves.
*MatchTrialsApi* | [**get_match_trial**](docs/MatchTrialsApi.md#get_match_trial) | **GET** /matches/{match_uuid}/trials/{trial_no} | Retrieve status of a specific Match Trial related to the Solution submitted by the Participant themselves.
*MatchTrialsApi* | [**get_solution**](docs/MatchTrialsApi.md#get_solution) | **GET** /matches/{match_uuid}/trials/{trial_no}/solution | Retrieve the Solution submitted by the Participant themselves.
## Documentation For Models
- [AuthErrorCode](docs/AuthErrorCode.md)
- [AuthErrorResponse](docs/AuthErrorResponse.md)
- [CreateMatchTrial400Response](docs/CreateMatchTrial400Response.md)
- [CreateMatchTrial403Response](docs/CreateMatchTrial403Response.md)
- [CreateMatchTrial404Response](docs/CreateMatchTrial404Response.md)
- [CreateMatchTrialRequest](docs/CreateMatchTrialRequest.md)
- [GetMatchEvaluation404Response](docs/GetMatchEvaluation404Response.md)
- [GetMatchScore404Response](docs/GetMatchScore404Response.md)
- [GetMatchTrial403Response](docs/GetMatchTrial403Response.md)
- [GetMatchTrial404Response](docs/GetMatchTrial404Response.md)
- [GetSolution404Response](docs/GetSolution404Response.md)
- [MatchTrialEvaluation](docs/MatchTrialEvaluation.md)
- [MatchTrialResponse](docs/MatchTrialResponse.md)
- [MatchTrialScore](docs/MatchTrialScore.md)
- [MatchTrialStatus](docs/MatchTrialStatus.md)
- [RunnerStatus](docs/RunnerStatus.md)
- [ScalarOrVector](docs/ScalarOrVector.md)
- [ServerErrorCode](docs/ServerErrorCode.md)
- [ServerErrorResponse](docs/ServerErrorResponse.md)
- [Solution](docs/Solution.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth
- **Type**: API key
- **API key parameter name**: x-api-key
- **Location**: HTTP header
## Author
dev@opthub.ai
Raw data
{
"_id": null,
"home_page": "https://github.com/opthub-org/opthub-api-client-python",
"name": "opthub_api_client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, OptHub REST API",
"author": "OpenAPI Generator Community",
"author_email": "dev@opthub.ai",
"download_url": "https://files.pythonhosted.org/packages/b2/75/f2b87e167a5db0e651298d8ade653f6b023ed809e5978c88c2b54120f004/opthub_api_client-0.3.0.tar.gz",
"platform": null,
"description": "# opthub-api-client\nOptHub Public REST API.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 0.3.0\n- Package version: 0.3.0\n- Generator version: 7.8.0-SNAPSHOT\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/opthub-org/opthub-api-client-python.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/opthub-org/opthub-api-client-python.git`)\n\nThen import the package:\n```python\nimport opthub_api_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 opthub_api_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 opthub_api_client\nfrom opthub_api_client.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.opthub.ai\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = opthub_api_client.Configuration(\n host = \"https://api.opthub.ai\"\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 API key authorization: ApiKeyAuth\nconfiguration.api_key['ApiKeyAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['ApiKeyAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith opthub_api_client.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = opthub_api_client.MatchTrialsApi(api_client)\n match_uuid = '5d7fc778-3e59-4128-a797-2e423c0aa461' # str | Match UUID\n create_match_trial_request = opthub_api_client.CreateMatchTrialRequest() # CreateMatchTrialRequest | (optional)\n\n try:\n # Create a match trial\n api_response = api_instance.create_match_trial(match_uuid, create_match_trial_request=create_match_trial_request)\n print(\"The response of MatchTrialsApi->create_match_trial:\\n\")\n pprint(api_response)\n except ApiException as e:\n print(\"Exception when calling MatchTrialsApi->create_match_trial: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.opthub.ai*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*MatchTrialsApi* | [**create_match_trial**](docs/MatchTrialsApi.md#create_match_trial) | **POST** /matches/{match_uuid}/trials | Create a match trial\n*MatchTrialsApi* | [**get_match_evaluation**](docs/MatchTrialsApi.md#get_match_evaluation) | **GET** /matches/{match_uuid}/trials/{trial_no}/evaluation | Retrieve status of a specific match evaluation related to the Solution submitted by the Participant themselves.\n*MatchTrialsApi* | [**get_match_score**](docs/MatchTrialsApi.md#get_match_score) | **GET** /matches/{match_uuid}/trials/{trial_no}/score | Retrieve status of a specific match score related to the Solution submitted by the Participant themselves.\n*MatchTrialsApi* | [**get_match_trial**](docs/MatchTrialsApi.md#get_match_trial) | **GET** /matches/{match_uuid}/trials/{trial_no} | Retrieve status of a specific Match Trial related to the Solution submitted by the Participant themselves.\n*MatchTrialsApi* | [**get_solution**](docs/MatchTrialsApi.md#get_solution) | **GET** /matches/{match_uuid}/trials/{trial_no}/solution | Retrieve the Solution submitted by the Participant themselves.\n\n\n## Documentation For Models\n\n - [AuthErrorCode](docs/AuthErrorCode.md)\n - [AuthErrorResponse](docs/AuthErrorResponse.md)\n - [CreateMatchTrial400Response](docs/CreateMatchTrial400Response.md)\n - [CreateMatchTrial403Response](docs/CreateMatchTrial403Response.md)\n - [CreateMatchTrial404Response](docs/CreateMatchTrial404Response.md)\n - [CreateMatchTrialRequest](docs/CreateMatchTrialRequest.md)\n - [GetMatchEvaluation404Response](docs/GetMatchEvaluation404Response.md)\n - [GetMatchScore404Response](docs/GetMatchScore404Response.md)\n - [GetMatchTrial403Response](docs/GetMatchTrial403Response.md)\n - [GetMatchTrial404Response](docs/GetMatchTrial404Response.md)\n - [GetSolution404Response](docs/GetSolution404Response.md)\n - [MatchTrialEvaluation](docs/MatchTrialEvaluation.md)\n - [MatchTrialResponse](docs/MatchTrialResponse.md)\n - [MatchTrialScore](docs/MatchTrialScore.md)\n - [MatchTrialStatus](docs/MatchTrialStatus.md)\n - [RunnerStatus](docs/RunnerStatus.md)\n - [ScalarOrVector](docs/ScalarOrVector.md)\n - [ServerErrorCode](docs/ServerErrorCode.md)\n - [ServerErrorResponse](docs/ServerErrorResponse.md)\n - [Solution](docs/Solution.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=\"ApiKeyAuth\"></a>\n### ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: x-api-key\n- **Location**: HTTP header\n\n\n## Author\n\ndev@opthub.ai\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "OptHub REST API",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/opthub-org/opthub-api-client-python",
"Repository": "https://github.com/opthub-org/opthub-api-client-python"
},
"split_keywords": [
"openapi",
" openapi-generator",
" opthub rest api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "956c35ca609606b1b482f8158595d705416f1e7f3bafc133a1909aef1c23d004",
"md5": "0bcece176b05317a7c6cc6653aa3eb06",
"sha256": "4c6530699b16cf6372002dbb58f234e32d61d9dc02b7c13a06d6d12b6e43d1b6"
},
"downloads": -1,
"filename": "opthub_api_client-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0bcece176b05317a7c6cc6653aa3eb06",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.7",
"size": 48691,
"upload_time": "2024-09-06T06:55:09",
"upload_time_iso_8601": "2024-09-06T06:55:09.601082Z",
"url": "https://files.pythonhosted.org/packages/95/6c/35ca609606b1b482f8158595d705416f1e7f3bafc133a1909aef1c23d004/opthub_api_client-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b275f2b87e167a5db0e651298d8ade653f6b023ed809e5978c88c2b54120f004",
"md5": "1ba15e1a72bdee13b495dd29f6b38bb1",
"sha256": "12c2334722d2f02b9578992119b3742ee067bc065596ef7832d523b9ffec20ca"
},
"downloads": -1,
"filename": "opthub_api_client-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "1ba15e1a72bdee13b495dd29f6b38bb1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.7",
"size": 25569,
"upload_time": "2024-09-06T06:55:11",
"upload_time_iso_8601": "2024-09-06T06:55:11.268651Z",
"url": "https://files.pythonhosted.org/packages/b2/75/f2b87e167a5db0e651298d8ade653f6b023ed809e5978c88c2b54120f004/opthub_api_client-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-06 06:55:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opthub-org",
"github_project": "opthub-api-client-python",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "opthub_api_client"
}
JSON
