# TIR - Test Interface Robot
TIR is a Python module used to create test scripts for web interfaces. With it, you can easily create and execute test suites and test cases for any supported web interface systems, such as Protheus Webapp.
### Current Supported Technologies
- Protheus Webapp
- APW
## Table of Contents
[Documentation](#documentation)<br>
[Installation](#installation)<br>
[Config](#config)<br>
[Usage](#usage)<br>
[Docker](#docker)<br>
[Samples](#samples)<br>
[Contact Us](#contact)<br>
[Contributing](#contributing)
## Documentation
Our documentation can be found here:
- [TIR Documentation](https://totvs.github.io/tir-docs/)
- [TIR Technical Documentation](https://totvs.github.io/tir/)
This project has a docs folder with [Sphinx](http://www.sphinx-doc.org/en/master/) files.
Our **create_docs.cmd** script handles the installation of dependencies and creates the offline documentation on the doc_files/build/html folder.
## Installation
The installation is pretty simple. All you need as a requirement is Python 3.7.9 (Mozilla Firefox) installed in your system.
There are three ways of installing TIR:
### 1. Installing and Upgrade from PyPI
TIR can be installed via pip from [Pypi](https://pypi.org/project/tir-framework/)
```shell
pip install tir_framework --upgrade
```
### 2. via Terminal(Deprecated For The Branch Master)
You can install TIR via the terminal. Make sure your Python and Git are installed and run this command:
```shell
pip install git+https://github.com/totvs/tir.git --upgrade
```
It will install the last release of TIR in the active Python instance.
## Config
The environment must be configured through a [config.json](config.json) file.
You can find one to be used as a base in this repository. To select your file,
you can either put it in your workspace or pass its path as a parameter of any of our classes' initialization.
### Config options
Here you can find all the supported keys: [Config.json keys](https://totvs.github.io/tir/configjson)
### Custom config path
Just pass the path as a parameter in your script:
#### Protheus WebApp Class example:
```python
#To use a custom path for your config.json
test_helper = Webapp("C:\PATH_HERE\config.json")
```
## Usage
After the module is installed, you could just import it into your Test Case.
See the following example:
[**Protheus WebApp Class**](https://totvs.github.io/tir-docs/TIR/first/)
## Samples
We have a repository with different samples of TIR scripts:
[TIR Script Samples](https://github.com/totvs/tir-script-samples)
## Contact
[Gitter](https://gitter.im/totvs-tir/General)
## Contributing
To contribute be sure to follow the [Contribution](CONTRIBUTING.md) guidelines.
Also, it's important to understand the chosen [architecture](https://github.com/totvs/tir/blob/master/doc_files/ARCHITECTURE.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/totvs/tir",
"name": "tir-framework",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "test automation selenium tir totvs protheus framework",
"author": "tir_engpro",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/74/9f/cf5a2b136e71860e6332d2bc462e9a5e2a9706b2130d3bb09064a4641320/tir_framework-1.20.19.tar.gz",
"platform": null,
"description": "# TIR - Test Interface Robot\n\n\nTIR is a Python module used to create test scripts for web interfaces. With it, you can easily create and execute test suites and test cases for any supported web interface systems, such as Protheus Webapp.\n\n### Current Supported Technologies\n\n- Protheus Webapp\n- APW\n\n## Table of Contents\n\n[Documentation](#documentation)<br>\n[Installation](#installation)<br>\n[Config](#config)<br>\n[Usage](#usage)<br>\n[Docker](#docker)<br>\n[Samples](#samples)<br>\n[Contact Us](#contact)<br>\n[Contributing](#contributing)\n\n## Documentation\nOur documentation can be found here:\n\n- [TIR Documentation](https://totvs.github.io/tir-docs/)\n\n- [TIR Technical Documentation](https://totvs.github.io/tir/)\n\nThis project has a docs folder with [Sphinx](http://www.sphinx-doc.org/en/master/) files.\n\nOur **create_docs.cmd** script handles the installation of dependencies and creates the offline documentation on the doc_files/build/html folder.\n\n## Installation\n\nThe installation is pretty simple. All you need as a requirement is Python 3.7.9 (Mozilla Firefox) installed in your system.\n\nThere are three ways of installing TIR:\n\n### 1. Installing and Upgrade from PyPI\n\nTIR can be installed via pip from [Pypi](https://pypi.org/project/tir-framework/)\n\n```shell\npip install tir_framework --upgrade\n```\n\n### 2. via Terminal(Deprecated For The Branch Master)\n\nYou can install TIR via the terminal. Make sure your Python and Git are installed and run this command:\n\n```shell\npip install git+https://github.com/totvs/tir.git --upgrade\n```\n\nIt will install the last release of TIR in the active Python instance.\n\n## Config\n\nThe environment must be configured through a [config.json](config.json) file.\nYou can find one to be used as a base in this repository. To select your file,\nyou can either put it in your workspace or pass its path as a parameter of any of our classes' initialization.\n\n### Config options\n\nHere you can find all the supported keys: [Config.json keys](https://totvs.github.io/tir/configjson)\n\n### Custom config path\n\nJust pass the path as a parameter in your script:\n\n#### Protheus WebApp Class example:\n```python\n#To use a custom path for your config.json\ntest_helper = Webapp(\"C:\\PATH_HERE\\config.json\")\n```\n\n## Usage\n\nAfter the module is installed, you could just import it into your Test Case.\nSee the following example:\n\n[**Protheus WebApp Class**](https://totvs.github.io/tir-docs/TIR/first/)\n\n\n## Samples\n\nWe have a repository with different samples of TIR scripts:\n\n[TIR Script Samples](https://github.com/totvs/tir-script-samples)\n\n## Contact\n\n[Gitter](https://gitter.im/totvs-tir/General)\n\n## Contributing\n\nTo contribute be sure to follow the [Contribution](CONTRIBUTING.md) guidelines.\n\nAlso, it's important to understand the chosen [architecture](https://github.com/totvs/tir/blob/master/doc_files/ARCHITECTURE.md).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Test Interface Robot",
"version": "1.20.19",
"project_urls": {
"Download": "https://github.com/totvs/tir",
"Homepage": "https://github.com/totvs/tir",
"Script Samples": "https://github.com/totvs/tir-script-samples"
},
"split_keywords": [
"test",
"automation",
"selenium",
"tir",
"totvs",
"protheus",
"framework"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "749fcf5a2b136e71860e6332d2bc462e9a5e2a9706b2130d3bb09064a4641320",
"md5": "da57b273b45e60727e84e19776974cdf",
"sha256": "0d8da1a800aa11a84ed1993335eaac5b961f238906bc0875d63d74af7f6a4bf5"
},
"downloads": -1,
"filename": "tir_framework-1.20.19.tar.gz",
"has_sig": false,
"md5_digest": "da57b273b45e60727e84e19776974cdf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18828154,
"upload_time": "2024-04-16T19:19:01",
"upload_time_iso_8601": "2024-04-16T19:19:01.167274Z",
"url": "https://files.pythonhosted.org/packages/74/9f/cf5a2b136e71860e6332d2bc462e9a5e2a9706b2130d3bb09064a4641320/tir_framework-1.20.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-16 19:19:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "totvs",
"github_project": "tir",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tir-framework"
}
JSON
