# Testops Robot
TestOps Robot for Python language.
## Usage
### Configuration
#### Environment variables
Configurations will be read from environment variables, and properties file in this order.
* `TESTOPS_SERVER_URL`
Katalon TestOps endpoint (default: `https://testops.katalon.io`).
* `TESTOPS_API_KEY`
Your Katalon TestOps API Key.
* `TESTOPS_PROJECT_ID`
The Katalon TestOps project that will receive the test results.
* `TESTOPS_BASELINE_COLLECTION_ID`
The Baseline Collection will choose to compare with checkpoints created by the test and support continuous testing with AI - Visual Testing.
* `TESTOPS_REPORT_FOLDER`
The local directory where test results will be written to (default: `testops-report`).
* `TESTOPS_PROXY_SERVER_TYPE`
* `TESTOPS_PROXY_HOST`
* `TESTOPS_PROXY_PORT`
* `TESTOPS_PROXY_USERNAME`
* `TESTOPS_PROXY_PASSWORD`
#### Configuration file
Create a `testops-config.json` file in the top-level directory.
```
{
// Default value: https://testops.katalon.io
"basePath": "",
"apiKey": "",
"projectId": "",
// Support continuous testing with AI - Visual Testing
"baselineCollectionId": "",
// Default value: testops-report
"reportFolder": "",
"proxy": {
"protocol": "", // Value: http, https
"host": "",
"port": "",
"auth": {
"username": "",
"password": ""
}
}
}
```
#### Install testops-robot plugin
```
pip3 install testops-robot
```
#### Run with robot with listener
```
robot --listener testops.Listener <file .robot>
```
## Samples
```
TODO: create sample repo for robot framwork in katalon
```
Raw data
{
"_id": null,
"home_page": "https://github.com/katalon-studio/testops-robot",
"name": "testops-robot",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "Katalon,TestOps",
"author": "Katalon, LLC. (https://www.katalon.io)",
"author_email": "info@katalon.io",
"download_url": "https://files.pythonhosted.org/packages/13/38/970b01cc52f93446f8d02c57b9200a134d2aa62834fd3a6f99ec5e78124f/testops-robot-1.0.0.tar.gz",
"platform": null,
"description": "# Testops Robot\nTestOps Robot for Python language.\n\n## Usage\n\n### Configuration\n\n#### Environment variables\n\nConfigurations will be read from environment variables, and properties file in this order.\n\n* `TESTOPS_SERVER_URL`\n\n Katalon TestOps endpoint (default: `https://testops.katalon.io`).\n\n* `TESTOPS_API_KEY`\n\n Your Katalon TestOps API Key.\n\n* `TESTOPS_PROJECT_ID`\n\n The Katalon TestOps project that will receive the test results.\n\n* `TESTOPS_BASELINE_COLLECTION_ID`\n\n The Baseline Collection will choose to compare with checkpoints created by the test and support continuous testing with AI - Visual Testing.\n\n* `TESTOPS_REPORT_FOLDER`\n\n The local directory where test results will be written to (default: `testops-report`).\n\n* `TESTOPS_PROXY_SERVER_TYPE`\n\n* `TESTOPS_PROXY_HOST`\n\n* `TESTOPS_PROXY_PORT`\n\n* `TESTOPS_PROXY_USERNAME`\n\n* `TESTOPS_PROXY_PASSWORD`\n\n\n#### Configuration file\n\nCreate a `testops-config.json` file in the top-level directory.\n\n```\n{\n // Default value: https://testops.katalon.io\n \"basePath\": \"\",\n \"apiKey\": \"\",\n \"projectId\": \"\",\n // Support continuous testing with AI - Visual Testing\n \"baselineCollectionId\": \"\",\n // Default value: testops-report\n \"reportFolder\": \"\",\n \"proxy\": {\n \"protocol\": \"\", // Value: http, https\n \"host\": \"\",\n \"port\": \"\",\n \"auth\": {\n \"username\": \"\",\n \"password\": \"\"\n }\n }\n}\n\n```\n\n#### Install testops-robot plugin\n```\npip3 install testops-robot\n```\n#### Run with robot with listener\n```\nrobot --listener testops.Listener <file .robot>\n```\n## Samples\n```\nTODO: create sample repo for robot framwork in katalon\n```\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Katalon TestOps Robot Plugin",
"version": "1.0.0",
"split_keywords": [
"katalon",
"testops"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "e5c44c0ed3f4b91ef59ad08bee5a3b26",
"sha256": "0f7c332a7e86410a25a3a5072d2813e0dbca1aa8b26584c1ec571aeaba794071"
},
"downloads": -1,
"filename": "testops_robot-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e5c44c0ed3f4b91ef59ad08bee5a3b26",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 4215,
"upload_time": "2022-12-07T08:49:21",
"upload_time_iso_8601": "2022-12-07T08:49:21.920326Z",
"url": "https://files.pythonhosted.org/packages/54/37/9238eb1df946ddaa1f89da14242448651d4efd32f26114b9190e41316985/testops_robot-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "eeb18877779cbbff4649874da37e493b",
"sha256": "621d9787a701d2b4592629d60195af16f464fd7d7d8f7d4bac57f68ea63e21a9"
},
"downloads": -1,
"filename": "testops-robot-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "eeb18877779cbbff4649874da37e493b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 3336,
"upload_time": "2022-12-07T08:49:23",
"upload_time_iso_8601": "2022-12-07T08:49:23.770872Z",
"url": "https://files.pythonhosted.org/packages/13/38/970b01cc52f93446f8d02c57b9200a134d2aa62834fd3a6f99ec5e78124f/testops-robot-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-07 08:49:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "katalon-studio",
"github_project": "testops-robot",
"lcname": "testops-robot"
}
JSON
