# qase
Qase TestOps API v2 Specification.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 2.0.0
- Package version: 1.0.0
- Generator version: 7.4.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://qase.io](https://qase.io)
## 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 qase.api_client_v2
```
### 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 qase.api_client_v2
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
from qase.api_client_v2.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.qase.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = qase.api_client_v2.Configuration(
host="https://api.qase.io/v2"
)
# 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: TokenAuth
configuration.api_key['TokenAuth'] = os.environ["API_KEY"]
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['TokenAuth'] = 'Bearer'
# Enter a context with an instance of the API client
with qase.api_client_v2.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = qase.api_client_v2.ResultsApi(api_client)
project_code = 'project_code_example' # str |
run_id = 56 # int |
result_create = qase.api_client_v2.ResultCreate() # ResultCreate |
try:
# (Beta) Create test run result
api_instance.create_result_v2(project_code, run_id, result_create)
except ApiException as e:
print("Exception when calling ResultsApi->create_result_v2: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *https://api.qase.io/v2*
Class | Method | HTTP request | Description
--------------|---------------------------------------------------------------|-----------------------------------------------|------------------------------------
*ResultsApi* | [**create_result_v2**](docs/ResultsApi.md#create_result_v2) | **POST** /{project_code}/run/{run_id}/result | (Beta) Create test run result
*ResultsApi* | [**create_results_v2**](docs/ResultsApi.md#create_results_v2) | **POST** /{project_code}/run/{run_id}/results | (Beta) Bulk create test run result
## Documentation For Models
- [BaseErrorFieldResponse](docs/BaseErrorFieldResponse.md)
- [BaseErrorFieldResponseErrorFieldsInner](docs/BaseErrorFieldResponseErrorFieldsInner.md)
- [BaseErrorResponse](docs/BaseErrorResponse.md)
- [CreateResultV2422Response](docs/CreateResultV2422Response.md)
- [CreateResultsRequestV2](docs/CreateResultsRequestV2.md)
- [RelationSuite](docs/RelationSuite.md)
- [RelationSuiteItem](docs/RelationSuiteItem.md)
- [ResultCreate](docs/ResultCreate.md)
- [ResultExecution](docs/ResultExecution.md)
- [ResultRelations](docs/ResultRelations.md)
- [ResultStep](docs/ResultStep.md)
- [ResultStepData](docs/ResultStepData.md)
- [ResultStepExecution](docs/ResultStepExecution.md)
- [ResultStepStatus](docs/ResultStepStatus.md)
- [ResultStepsType](docs/ResultStepsType.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="TokenAuth"></a>
### TokenAuth
- **Type**: API key
- **API key parameter name**: Token
- **Location**: HTTP header
## Author
support@qase.io
Raw data
{
"_id": null,
"home_page": null,
"name": "qase-api-v2-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "OpenAPI, OpenAPI-Generator, Qase.io TestOps API",
"author": null,
"author_email": "Qase Team <support@qase.io>",
"download_url": "https://files.pythonhosted.org/packages/9b/19/eed292b53b3e55dd451706735521ae79585b524987e3ebd2540f4191844a/qase_api_v2_client-1.1.0.tar.gz",
"platform": null,
"description": "# qase\n\nQase TestOps API v2 Specification.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 2.0.0\n- Package version: 1.0.0\n- Generator version: 7.4.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n For more information, please visit [https://qase.io](https://qase.io)\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n\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\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\n```python\n\nimport qase.api_client_v2\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n\n```python\n\nimport qase.api_client_v2\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\nfrom qase.api_client_v2.rest import ApiException\nfrom pprint import pprint\n\n# Defining the host is optional and defaults to https://api.qase.io/v2\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = qase.api_client_v2.Configuration(\n host=\"https://api.qase.io/v2\"\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: TokenAuth\nconfiguration.api_key['TokenAuth'] = os.environ[\"API_KEY\"]\n\n# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed\n# configuration.api_key_prefix['TokenAuth'] = 'Bearer'\n\n\n# Enter a context with an instance of the API client\nwith qase.api_client_v2.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = qase.api_client_v2.ResultsApi(api_client)\n project_code = 'project_code_example' # str | \n run_id = 56 # int | \n result_create = qase.api_client_v2.ResultCreate() # ResultCreate | \n\n try:\n # (Beta) Create test run result\n api_instance.create_result_v2(project_code, run_id, result_create)\n except ApiException as e:\n print(\"Exception when calling ResultsApi->create_result_v2: %s\\n\" % e)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.qase.io/v2*\n\n Class | Method | HTTP request | Description \n--------------|---------------------------------------------------------------|-----------------------------------------------|------------------------------------\n *ResultsApi* | [**create_result_v2**](docs/ResultsApi.md#create_result_v2) | **POST** /{project_code}/run/{run_id}/result | (Beta) Create test run result \n *ResultsApi* | [**create_results_v2**](docs/ResultsApi.md#create_results_v2) | **POST** /{project_code}/run/{run_id}/results | (Beta) Bulk create test run result \n\n## Documentation For Models\n\n- [BaseErrorFieldResponse](docs/BaseErrorFieldResponse.md)\n- [BaseErrorFieldResponseErrorFieldsInner](docs/BaseErrorFieldResponseErrorFieldsInner.md)\n- [BaseErrorResponse](docs/BaseErrorResponse.md)\n- [CreateResultV2422Response](docs/CreateResultV2422Response.md)\n- [CreateResultsRequestV2](docs/CreateResultsRequestV2.md)\n- [RelationSuite](docs/RelationSuite.md)\n- [RelationSuiteItem](docs/RelationSuiteItem.md)\n- [ResultCreate](docs/ResultCreate.md)\n- [ResultExecution](docs/ResultExecution.md)\n- [ResultRelations](docs/ResultRelations.md)\n- [ResultStep](docs/ResultStep.md)\n- [ResultStepData](docs/ResultStepData.md)\n- [ResultStepExecution](docs/ResultStepExecution.md)\n- [ResultStepStatus](docs/ResultStepStatus.md)\n- [ResultStepsType](docs/ResultStepsType.md)\n\n<a id=\"documentation-for-authorization\"></a>\n\n## Documentation For Authorization\n\nAuthentication schemes defined for the API:\n<a id=\"TokenAuth\"></a>\n\n### TokenAuth\n\n- **Type**: API key\n- **API key parameter name**: Token\n- **Location**: HTTP header\n\n## Author\n\nsupport@qase.io\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Qase TestOps API V2 client for Python",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://github.com/qase-tms/qase-python"
},
"split_keywords": [
"openapi",
" openapi-generator",
" qase.io testops api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b4efe861777574acd91c634d397ad3558c4a39545b3962d485f5f6220edf2772",
"md5": "c95bd05a3e74dff5984740b01bb94850",
"sha256": "5607bae16e98db3967ed6d6725c5d40975a9398d6ef2abfe9867b3b91a713c0b"
},
"downloads": -1,
"filename": "qase_api_v2_client-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c95bd05a3e74dff5984740b01bb94850",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 44082,
"upload_time": "2024-10-29T12:43:57",
"upload_time_iso_8601": "2024-10-29T12:43:57.909433Z",
"url": "https://files.pythonhosted.org/packages/b4/ef/e861777574acd91c634d397ad3558c4a39545b3962d485f5f6220edf2772/qase_api_v2_client-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9b19eed292b53b3e55dd451706735521ae79585b524987e3ebd2540f4191844a",
"md5": "dcf6b591ebfd19c6e0446e3a2233193a",
"sha256": "495613c7a6b87082caec8c1fcafa8cbae5613341f8583c2ed018928d8b26f9de"
},
"downloads": -1,
"filename": "qase_api_v2_client-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "dcf6b591ebfd19c6e0446e3a2233193a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 27960,
"upload_time": "2024-10-29T12:43:59",
"upload_time_iso_8601": "2024-10-29T12:43:59.863116Z",
"url": "https://files.pythonhosted.org/packages/9b/19/eed292b53b3e55dd451706735521ae79585b524987e3ebd2540f4191844a/qase_api_v2_client-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-29 12:43:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qase-tms",
"github_project": "qase-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "qase-api-v2-client"
}
JSON
