Metadata-Version: 2.4
Name: robotframework-tai
Version: 0.1.0
Summary: TAI Custom Libraries
Project-URL: Homepage, https://github.com/delieloliveira/robotframework-tai
Project-URL: Bug Tracker, https://github.com/delieloliveira/robotframework-tai/issues
Author-email: Deliel Oliveira de Albuquerque <deliel.albuquerque@gmail.com>
License: MIT
Classifier: Framework :: Robot Framework
Classifier: Framework :: Robot Framework :: Library
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: boto3>=1.0.0
Requires-Dist: faker>=13.0.0
Requires-Dist: pandas>=1.0.0
Requires-Dist: pillow>=9.0.0
Requires-Dist: requests>=2.0.0
Requires-Dist: robotframework>=5.0
Description-Content-Type: text/markdown

# TAI Libraries

Custom libraries and CLI tools for Test Automation Integrated (TAI) projects.

## Installation

### From Source
```bash
pip install .
```

### From GitHub (Internal)
```bash
pip install git+https://github.com/delieloliveira/natura-robotframework.git@main
```

## CLI Usage

This package includes the `tai` command-line interface to help you scaffold new automation projects quickly.

### Initialize a New Project

```bash
tai init [template] [options]
```

**Arguments:**
- `template`: The project template to use. Defaults to `web`.
    - `web`: Standard Web automation structure.
    - `api`: API testing structure.
    - `mobile`: Mobile automation structure.
    - `web-playwright`: Web automation using Playwright.

**Options:**
- `--venv`: Automatically creates a virtual environment (`.venv`).
- `--install`: Installs dependencies from the template's `requirements.txt`.

**Examples:**

```bash
# Basic Web Project
tai init

# API Project with Auto-Setup
tai init api --venv --install

# Playwright Project
tai init web-playwright
```

> **Note:** `tai init` must be run in an empty directory.

## Library Usage

### Importing in Robot Framework

```robot
*** Settings ***
Library    tai
Library    tai.Confluence
Library    tai.document_generator
```

### Supported Modules

#### Generators
Data generation utilities for different countries.
- **Brasil**: `Generate Brazil Cep` (alias: `Gerar Cep`)
- **Equador**: `Generate Ecuador Cedula` (alias: `Generate Random Cedula`)
- **Mexico**: `Generate Mexico Curp` (alias: `Generate Curp`)

#### Utilities
- **Document Generator**: Generation of document images (CNH, RG, DNI, etc.) for OCR testing.
- **Atlassian**: Confluence integration keywords.
- **AWS**: AWS AppConfig integration.

### Python Code Example

```python
from tai import generate_brazil_cep, generate_ecuador_cedula
from tai import Confluence

# New naming convention
cep = generate_brazil_cep("data/ceps.csv")
cedula = generate_ecuador_cedula()

# ...
```