# 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)
# Utilizando TIR com ambiente virtual
## Conhecendo o conceito
Para execução do TIR em ambiente virtual, utilizaremos a biblioteca **Virtualenv**. Essa é uma ferramenta usada em Python para criar ambientes **isolados**. Cada ambiente virtual tem seus próprios diretórios de instalação de pacotes, separados do ambiente **global** do sistema. Isso é útil para gerenciar dependências de **diferentes** projetos/versões sem conflito.
## Configurando com VScode
### Instalando a biblioteca e Criando o ambiente
1. No terminal, execute o comando `pip install virtualenv` para instalar a biblioteca de ambiente virtual.
2. Ainda no terminal, execute o comando `python -m virtualenv venv` para criação de um ambiente no diretório atual.
>**Nota:** Caso você possua mais de uma versão de Python instalada pode ser necessário especificar a versão desejada. Verifique o caminho de instalação do executável e referencie ele no comando
Exemplo: `C:/caminho/python/python -m virtualenv venv`
>>Por padrao a pasta de instalaçao do Pyhon fica em **C:\Users\[user]\AppData\Local\Programs\Python\Python[version]**.
3. Será adicionada uma pasta (venv) no diretório atual , com isso o ambiente estará pronto para utilização.
### Configurando o Vscode
Após a configuração do ambiente virtual iremos definir o interpretador do VScode para utiliza-lo
1. Com o VScode aberto na pasta do projeto, pressione `Ctrl + Shift + P` e pesquise pela opção `>Python: Select Interpreter`
2. Na lista de interpretadores reconhecidos no sistema, selecione o interpretador anteriormente criado, caminho padrão é: **_./venv/Scripts/python.exe_** . Ao selecionar, o interpretador padrao utilizado se tornara esse, caso deseje utilizar outro é só seleciona-lo na lista.
3. Abra um novo terminal no Vscode indo em _"Terminal"_ e _"Novo terminal"_
4. Ao abrir o terminal veja se está inicializada a venv na linha de comando. 
5. Agora rode o comando para instalação do TIR! `pip install tir_framework`
7. Pronto! Agora seu tir esta pronto para executar em um ambiente isolado!.
## 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/e1/3e/7ef926433d9b338454e1644b9416cd5058d9038ad58b39117ba1a9cb4a2e/tir_framework-1.20.28.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\n# Utilizando TIR com ambiente virtual \n\n## Conhecendo o conceito\nPara execu\u00e7\u00e3o do TIR em ambiente virtual, utilizaremos a biblioteca **Virtualenv**. Essa \u00e9 uma ferramenta usada em Python para criar ambientes **isolados**. Cada ambiente virtual tem seus pr\u00f3prios diret\u00f3rios de instala\u00e7\u00e3o de pacotes, separados do ambiente **global** do sistema. Isso \u00e9 \u00fatil para gerenciar depend\u00eancias de **diferentes** projetos/vers\u00f5es sem conflito.\n\n## Configurando com VScode\n### Instalando a biblioteca e Criando o ambiente\n1. No terminal, execute o comando `pip install virtualenv` para instalar a biblioteca de ambiente virtual.\n\n2. Ainda no terminal, execute o comando `python -m virtualenv venv` para cria\u00e7\u00e3o de um ambiente no diret\u00f3rio atual.\n>**Nota:** Caso voc\u00ea possua mais de uma vers\u00e3o de Python instalada pode ser necess\u00e1rio especificar a vers\u00e3o desejada. Verifique o caminho de instala\u00e7\u00e3o do execut\u00e1vel e referencie ele no comando\nExemplo: `C:/caminho/python/python -m virtualenv venv` \n>>Por padrao a pasta de instala\u00e7ao do Pyhon fica em **C:\\Users\\[user]\\AppData\\Local\\Programs\\Python\\Python[version]**.\n3. Ser\u00e1 adicionada uma pasta (venv) no diret\u00f3rio atual , com isso o ambiente estar\u00e1 pronto para utiliza\u00e7\u00e3o.\n\n### Configurando o Vscode \nAp\u00f3s a configura\u00e7\u00e3o do ambiente virtual iremos definir o interpretador do VScode para utiliza-lo\n1. Com o VScode aberto na pasta do projeto, pressione `Ctrl + Shift + P` e pesquise pela op\u00e7\u00e3o `>Python: Select Interpreter`\n\n2. Na lista de interpretadores reconhecidos no sistema, selecione o interpretador anteriormente criado, caminho padr\u00e3o \u00e9: **_./venv/Scripts/python.exe_** . Ao selecionar, o interpretador padrao utilizado se tornara esse, caso deseje utilizar outro \u00e9 s\u00f3 seleciona-lo na lista.\n\n3. Abra um novo terminal no Vscode indo em _\"Terminal\"_ e _\"Novo terminal\"_\n\n4. Ao abrir o terminal veja se est\u00e1 inicializada a venv na linha de comando. \n\n5. Agora rode o comando para instala\u00e7\u00e3o do TIR! `pip install tir_framework`\n\n7. Pronto! Agora seu tir esta pronto para executar em um ambiente isolado!.\n\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.28",
"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": "e13e7ef926433d9b338454e1644b9416cd5058d9038ad58b39117ba1a9cb4a2e",
"md5": "7b36a1ecf45986cf3ce946178275f2cd",
"sha256": "7f33f1e07c604c2bea2fe48c24b46f426f520ea289fbafdc4c19f9ba1eaf7869"
},
"downloads": -1,
"filename": "tir_framework-1.20.28.tar.gz",
"has_sig": false,
"md5_digest": "7b36a1ecf45986cf3ce946178275f2cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 18833231,
"upload_time": "2024-12-06T13:02:09",
"upload_time_iso_8601": "2024-12-06T13:02:09.317491Z",
"url": "https://files.pythonhosted.org/packages/e1/3e/7ef926433d9b338454e1644b9416cd5058d9038ad58b39117ba1a9cb4a2e/tir_framework-1.20.28.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-06 13:02:09",
"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
