tir-framework


Nametir-framework JSON
Version 1.16.19 PyPI version JSON
download
home_pagehttps://github.com/totvs/tir
SummaryTOTVS Interface Robot
upload_time2020-07-31 19:40:05
maintainer
docs_urlNone
authortir_engpro
requires_python
licenseMIT
keywords test automation selenium tir totvs protheus framework
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # TIR - Totvs Interface Robot

TIR is a Python module used to create test scripts for web interfaces. With it, you are able to easily create and execute test suites and test cases for any supported Totvs' 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>
[Samples](#samples)<br>
[Contact Us](#contact)<br>
[Contributing](#contributing)

## Documentation
Our documentation can be found here:

- [TIR 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 doc_files/build/html folder.

## Installation

The installation is pretty simple. All you need as a requirement is Python 3.6 or greater and a browser (Mozilla Firefox/Google Chrome) installed in your system.

There are three ways of installing TIR:

### 1. Installing from PyPI

TIR can ben installed via pip from [Pypi](https://pypi.org/project/tir-framework/)

```shell
pip install tir_framework
```

### 2. via Terminal

You can install TIR via terminal. Make sure your Python and Git is 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 on your Test Case.
See the following **Protheus WebApp Class** example:
```python
# Import from our package the class you're going to use
from tir import Webapp

test_helper = Webapp()
test_helper.Setup('SIGAGCT','10/08/2017','T1','D MG 01 ','05')
test_helper.Program('CNTA010')

test_helper.SetButton('Cancelar')
test_helper.AssertTrue()

test_helper.TearDown()
```

## 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

In order to contribute be sure to follow the [Contribution](CONTRIBUTING.md) guidelines.

Also, it's import 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": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "test automation selenium tir totvs protheus framework",
    "author": "tir_engpro",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/be/93/51a83a5acdcbc669b903fdd906fd19187837b6e55f41e02a9dda212ce981/tir_framework-1.16.19.tar.gz",
    "platform": "",
    "description": "# TIR - Totvs Interface Robot\n\nTIR is a Python module used to create test scripts for web interfaces. With it, you are able to easily create and execute test suites and test cases for any supported Totvs' 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[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/)\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 doc_files/build/html folder.\n\n## Installation\n\nThe installation is pretty simple. All you need as a requirement is Python 3.6 or greater and a browser (Mozilla Firefox/Google Chrome) installed in your system.\n\nThere are three ways of installing TIR:\n\n### 1. Installing from PyPI\n\nTIR can ben installed via pip from [Pypi](https://pypi.org/project/tir-framework/)\n\n```shell\npip install tir_framework\n```\n\n### 2. via Terminal\n\nYou can install TIR via terminal. Make sure your Python and Git is 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 on your Test Case.\nSee the following **Protheus WebApp Class** example:\n```python\n# Import from our package the class you're going to use\nfrom tir import Webapp\n\ntest_helper = Webapp()\ntest_helper.Setup('SIGAGCT','10/08/2017','T1','D MG 01 ','05')\ntest_helper.Program('CNTA010')\n\ntest_helper.SetButton('Cancelar')\ntest_helper.AssertTrue()\n\ntest_helper.TearDown()\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\nIn order to contribute be sure to follow the [Contribution](CONTRIBUTING.md) guidelines.\n\nAlso, it's import to understand the chosen [architecture](https://github.com/totvs/tir/blob/master/doc_files/ARCHITECTURE.md).",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "TOTVS Interface Robot",
    "version": "1.16.19",
    "split_keywords": [
        "test",
        "automation",
        "selenium",
        "tir",
        "totvs",
        "protheus",
        "framework"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "20a89ca1b5afa2adfc16c0641212809e",
                "sha256": "687cd7289cbee1892caa8dac3bf11988cdab4179f8d8f74d8ff6ce22b3703d30"
            },
            "downloads": -1,
            "filename": "tir_framework-1.16.19.tar.gz",
            "has_sig": false,
            "md5_digest": "20a89ca1b5afa2adfc16c0641212809e",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15134444,
            "upload_time": "2020-07-31T19:40:05",
            "upload_time_iso_8601": "2020-07-31T19:40:05.963959Z",
            "url": "https://files.pythonhosted.org/packages/be/93/51a83a5acdcbc669b903fdd906fd19187837b6e55f41e02a9dda212ce981/tir_framework-1.16.19.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-07-31 19:40:05",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "totvs",
    "error": "Could not fetch GitHub repository",
    "lcname": "tir-framework"
}
        
Elapsed time: 0.14447s