robotframework-gemini 0.3.0__tar.gz → 0.3.2__tar.gz

{robotframework_gemini-0.3.0 → robotframework_gemini-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-gemini
-Version: 0.3.0
+Version: 0.3.2
 Summary: Google Gemini oracles for Robot Framework: text-only and multimodal (image) assertions.
 Project-URL: Homepage, https://github.com/carlosnizolli/robotframework-gemini
 Project-URL: Documentation, https://github.com/carlosnizolli/robotframework-gemini#readme
@@ -34,7 +34,7 @@ Description-Content-Type: text/markdown
 
 # robotframework-gemini
 
-Biblioteca **Python** e **keywords do Robot Framework** para oráculos com **Google Gemini**: avaliação **só texto** (API, logs, JSON, etc.) ou **multimodal** com imagem (arquivo PNG ou captura do **Robot Framework Browser**).
+Biblioteca de **keywords do Robot Framework** para oráculos com **Google Gemini**: avaliação **só texto** (API, logs, JSON, etc.) ou **multimodal** com imagem (arquivo PNG ou captura do **Robot Framework Browser**).
 
 - **Multimodal**: envia o texto do prompt e a captura como `Part` em bytes (`google-genai`).
 - **Fluxo recomendado**: duas entradas — **contexto** (enquadramento do teste) e **avaliação** (critério ou pergunta objetiva).
@@ -59,35 +59,45 @@ Desenvolvimento local:
 python -m pip install -e ".[dev]"
 ```
 
-## Variáveis de ambiente
+## Variáveis de ambiente e importação da Library
 
-| Variável          | Função                                      |
-|-------------------|---------------------------------------------|
-| `GEMINI_API_KEY`  | Chave da API Gemini (obrigatória se não passar `api_key` na Library) |
-| `GEMINI_MODEL`    | Modelo (ex.: `gemini-2.0-flash`). Se omitido, usa `gemini-2.0-flash`. |
+| Variável / argumento | Função |
+|----------------------|--------|
+| `GEMINI_API_KEY` | Chave da API Gemini (obrigatória se não passar `api_key` na Library) |
+| `GEMINI_MODEL` | Modelo (ex.: `gemini-3.1-flash-lite`). Se omitido, usa `gemini-2.5-flash`. |
+| `api_key` (import) | Sobrescreve `GEMINI_API_KEY` na importação da Library |
+| `model` (import) | Sobrescreve `GEMINI_MODEL` na importação da Library |
 
-## Uso em Python (`GeminiOrchestrator`)
+Por padrão, a Library lê chave e modelo das variáveis de ambiente. Você também pode passá-los na importação (útil em CI ou suítes com credenciais em variáveis Robot):
 
-```python
-from pathlib import Path
-from robotframework_gemini import GeminiOrchestrator
+```robot
+*** Variables ***
+${GEMINI_API_KEY}    %{GEMINI_API_KEY}
+${GEMINI_MODEL}      gemini-2.5-flash-lite
 
-orchestrator = GeminiOrchestrator()
-context = "Web dashboard with the 'Active' category filter applied."
-evaluation = "Do the visible list items match the selected category?"
-model_response = orchestrator.evaluate_with_image(context, evaluation, Path("screen.png"))
+*** Settings ***
+Library    GeminiLibrary    api_key=${GEMINI_API_KEY}    model=${GEMINI_MODEL}
 ```
 
-Para formato de saída restrito (ex.: Yes/No), use `extra_instructions`:
+Só o modelo (chave continua vinda do ambiente):
+
+```robot
+Library    GeminiLibrary    model=gemini-2.5-flash
+```
+
+Import explícito (equivalente):
 
-```python
-model_response = orchestrator.evaluate_with_text(
-    context,
-    evaluation,
-    extra_instructions="Reply with one word only: Yes or No.",
-)
+```robot
+Library    robotframework_gemini.library.GeminiLibrary    api_key=${GEMINI_API_KEY}    model=${GEMINI_MODEL}
 ```
 
+> Evite commitar a chave literal no repositório; prefira `%{GEMINI_API_KEY}` ou secrets do CI.
+
+## Documentação de Keywords
+
+- Português: [docs/KEYWORDS.pt-BR.md](https://github.com/carlosnizolli/robotframework-gemini/blob/main/docs/KEYWORDS.pt-BR.md)
+- English: [docs/KEYWORDS.en.md](https://github.com/carlosnizolli/robotframework-gemini/blob/main/docs/KEYWORDS.en.md)
+
 ## Uso no Robot Framework
 
 > **Nota:** os exemplos usam `Set Variable` e `Catenate` em vez da keyword `VAR` (Robot Framework 7.0+) para manter retrocompatibilidade com versões anteriores do Robot Framework.
@@ -123,12 +133,32 @@ Checar tela por critério neutro
     Log    ${model_response}
 ```
 
-Import explícito (equivalente):
+Import recomendado (RobotCode, runtime e PyPI):
 
 ```robot
-Library    robotframework_gemini.library.GeminiLibrary
+Library    GeminiLibrary    api_key=${GEMINI_API_KEY}    model=${GEMINI_MODEL}
 ```
 
+Import explícito do pacote (IDEs que preferem o caminho completo):
+
+```robot
+Library    robotframework_gemini.library.GeminiLibrary    api_key=${GEMINI_API_KEY}    model=${GEMINI_MODEL}
+```
+
+### IDE e RobotCode
+
+| Forma de import | Quem resolve |
+|-----------------|--------------|
+| `Library    GeminiLibrary` | Módulo top-level `GeminiLibrary.py` (instalado no wheel ou via `src/` no clone) |
+| `Library    robotframework_gemini.library.GeminiLibrary` | Pacote Python padrão |
+
+No **clone do repositório**, sem instalar:
+
+- [`robot.toml`](robot.toml) — `python-path = ["src"]` para RobotCode/LSP
+- [`.vscode/settings.json`](.vscode/settings.json) — `extraPaths` para Pylance/Cursor
+
+Com venv local: `pip install -e ".[dev]"` e recarregue a janela do IDE após mudanças.
+
 Com arquivo já salvo:
 
 ```robot
@@ -151,19 +181,9 @@ ${rating_score}=    Gemini Parse Rating    ${model_response}
 ${rating_score}=    Gemini Evaluate Text Rating Score    ${context}    ${evaluation}
 ```
 
-Detalhes das três keywords de nota: [`docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar`](docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar).
-
-Consulte também [`examples/demo_template.robot`](examples/demo_template.robot).
-
-## Documentação de Keywords
-
-- Português: [`docs/KEYWORDS.pt-BR.md`](docs/KEYWORDS.pt-BR.md)
-- English: [`docs/KEYWORDS.en.md`](docs/KEYWORDS.en.md)
-
-## Compatibilidade
+Detalhes das três keywords de nota: [Notas 1–5 (pt-BR)](https://github.com/carlosnizolli/robotframework-gemini/blob/main/docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar).
 
-- `BrowserGeminiLibrary` permanece como alias de `GeminiLibrary` para suítes existentes.
-- Variáveis legadas (`LLM_API_KEY`, `LLM_API_KEY_LIA`, `LLM_LIA_MODEL`) são mapeadas para `GEMINI_*` ao importar o pacote.
+Consulte também [examples/demo_template.robot](https://github.com/carlosnizolli/robotframework-gemini/blob/main/examples/demo_template.robot).
 
 ## Testes
 

robotframework_gemini-0.3.2/README.md

@@ -0,0 +1,164 @@
+# robotframework-gemini
+
+Biblioteca de **keywords do Robot Framework** para oráculos com **Google Gemini**: avaliação **só texto** (API, logs, JSON, etc.) ou **multimodal** com imagem (arquivo PNG ou captura do **Robot Framework Browser**).
+
+- **Multimodal**: envia o texto do prompt e a captura como `Part` em bytes (`google-genai`).
+- **Fluxo recomendado**: duas entradas — **contexto** (enquadramento do teste) e **avaliação** (critério ou pergunta objetiva).
+- **Browser opcional**: keywords de screenshot exigem `Library    Browser`; keywords de texto funcionam sem navegador.
+
+## Instalação
+
+```bash
+pip install robotframework-gemini
+```
+
+Com suporte a captura via Robot Framework Browser (Playwright):
+
+```bash
+pip install "robotframework-gemini[browser]"
+python -m pip install robotframework
+```
+
+Desenvolvimento local:
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+## Variáveis de ambiente e importação da Library
+
+| Variável / argumento | Função |
+|----------------------|--------|
+| `GEMINI_API_KEY` | Chave da API Gemini (obrigatória se não passar `api_key` na Library) |
+| `GEMINI_MODEL` | Modelo (ex.: `gemini-3.1-flash-lite`). Se omitido, usa `gemini-2.5-flash`. |
+| `api_key` (import) | Sobrescreve `GEMINI_API_KEY` na importação da Library |
+| `model` (import) | Sobrescreve `GEMINI_MODEL` na importação da Library |
+
+Por padrão, a Library lê chave e modelo das variáveis de ambiente. Você também pode passá-los na importação (útil em CI ou suítes com credenciais em variáveis Robot):
+
+```robot
+*** Variables ***
+${GEMINI_API_KEY}    %{GEMINI_API_KEY}
+${GEMINI_MODEL}      gemini-2.5-flash-lite
+
+*** Settings ***
+Library    GeminiLibrary    api_key=${GEMINI_API_KEY}    model=${GEMINI_MODEL}
+```
+
+Só o modelo (chave continua vinda do ambiente):
+
+```robot
+Library    GeminiLibrary    model=gemini-2.5-flash
+```
+
+Import explícito (equivalente):
+
+```robot
+Library    robotframework_gemini.library.GeminiLibrary    api_key=${GEMINI_API_KEY}    model=${GEMINI_MODEL}
+```
+
+> Evite commitar a chave literal no repositório; prefira `%{GEMINI_API_KEY}` ou secrets do CI.
+
+## Documentação de Keywords
+
+- Português: [docs/KEYWORDS.pt-BR.md](https://github.com/carlosnizolli/robotframework-gemini/blob/main/docs/KEYWORDS.pt-BR.md)
+- English: [docs/KEYWORDS.en.md](https://github.com/carlosnizolli/robotframework-gemini/blob/main/docs/KEYWORDS.en.md)
+
+## Uso no Robot Framework
+
+> **Nota:** os exemplos usam `Set Variable` e `Catenate` em vez da keyword `VAR` (Robot Framework 7.0+) para manter retrocompatibilidade com versões anteriores do Robot Framework.
+
+### Só texto (sem Browser)
+
+```robot
+*** Settings ***
+Library    GeminiLibrary
+
+*** Keywords ***
+Validar resposta da API
+    ${context}=       Set Variable    {"status": "ok", "items": 3}
+    ${evaluation}=    Set Variable    O payload indica sucesso com itens?
+    ${model_response}=    Gemini Evaluate Text    ${context}    ${evaluation}
+    Log    ${model_response}
+```
+
+### Com captura de tela (Browser)
+
+Declare a biblioteca **Browser** antes de **Gemini**:
+
+```robot
+*** Settings ***
+Library    Browser
+Library    GeminiLibrary
+
+*** Keywords ***
+Checar tela por critério neutro
+    ${context}=       Set Variable    Lista filtrada por status Ativo.
+    ${evaluation}=    Set Variable    Todos os itens visíveis mostram status Ativo?
+    ${model_response}=    Gemini Evaluate With Screen    ${context}    ${evaluation}
+    Log    ${model_response}
+```
+
+Import recomendado (RobotCode, runtime e PyPI):
+
+```robot
+Library    GeminiLibrary    api_key=${GEMINI_API_KEY}    model=${GEMINI_MODEL}
+```
+
+Import explícito do pacote (IDEs que preferem o caminho completo):
+
+```robot
+Library    robotframework_gemini.library.GeminiLibrary    api_key=${GEMINI_API_KEY}    model=${GEMINI_MODEL}
+```
+
+### IDE e RobotCode
+
+| Forma de import | Quem resolve |
+|-----------------|--------------|
+| `Library    GeminiLibrary` | Módulo top-level `GeminiLibrary.py` (instalado no wheel ou via `src/` no clone) |
+| `Library    robotframework_gemini.library.GeminiLibrary` | Pacote Python padrão |
+
+No **clone do repositório**, sem instalar:
+
+- [`robot.toml`](robot.toml) — `python-path = ["src"]` para RobotCode/LSP
+- [`.vscode/settings.json`](.vscode/settings.json) — `extraPaths` para Pylance/Cursor
+
+Com venv local: `pip install -e ".[dev]"` e recarregue a janela do IDE após mudanças.
+
+Com arquivo já salvo:
+
+```robot
+Browser.Take Screenshot    ${OUTPUT_DIR}/tela.png
+${model_response}=    Gemini Evaluate With Image File    ${context}    ${evaluation}    ${OUTPUT_DIR}/tela.png
+```
+
+Veredito via prompt (primeira linha) e nota 1–5:
+
+```robot
+${model_response}=    Gemini Evaluate With Screen    ${context}    ${evaluation}
+...    extra_instructions=Responda com uma palavra na primeira linha: Sim ou Não.
+${verdict}=    Get Line    ${model_response}    0
+Should Be Equal As Strings    ${verdict}    Sim
+
+# Nota 1–5: duas etapas (log da justificativa) ou atalho em uma linha
+${model_response}=    Gemini Evaluate Text Rating    ${context}    ${evaluation}
+${rating_score}=    Gemini Parse Rating    ${model_response}
+
+${rating_score}=    Gemini Evaluate Text Rating Score    ${context}    ${evaluation}
+```
+
+Detalhes das três keywords de nota: [Notas 1–5 (pt-BR)](https://github.com/carlosnizolli/robotframework-gemini/blob/main/docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar).
+
+Consulte também [examples/demo_template.robot](https://github.com/carlosnizolli/robotframework-gemini/blob/main/examples/demo_template.robot).
+
+## Testes
+
+```bash
+pytest
+```
+
+Os testes usam mocks de `generate_content`; não há chamadas reais à API.
+
+## Licença
+
+MIT.

{robotframework_gemini-0.3.0 → robotframework_gemini-0.3.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "robotframework-gemini"
-version = "0.3.0"
+version = "0.3.2"
 description = "Google Gemini oracles for Robot Framework: text-only and multimodal (image) assertions."
 readme = "README.md"
 requires-python = ">=3.10"
@@ -47,14 +47,24 @@ dev = [
 ]
 
 [project.entry-points."robotframework.libraries"]
-GeminiLibrary = "robotframework_gemini.library:GeminiLibrary"
+GeminiLibrary = "GeminiLibrary:GeminiLibrary"
+BrowserGeminiLibrary = "BrowserGeminiLibrary:BrowserGeminiLibrary"
 
 [tool.hatch.build.targets.wheel]
 packages = ["src/robotframework_gemini"]
 
+[tool.hatch.build.targets.wheel.force-include]
+"src/GeminiLibrary.py" = "GeminiLibrary.py"
+"src/BrowserGeminiLibrary.py" = "BrowserGeminiLibrary.py"
+
+[tool.hatch.build.targets.editable]
+dev-mode-dirs = ["src"]
+
 [tool.hatch.build.targets.sdist]
 include = [
     "src/robotframework_gemini",
+    "src/GeminiLibrary.py",
+    "src/BrowserGeminiLibrary.py",
     "LICENSE",
     "README.md",
 ]

robotframework_gemini-0.3.2/src/BrowserGeminiLibrary.py

@@ -0,0 +1,10 @@
+"""Backward-compatible shim for ``Library    BrowserGeminiLibrary``."""
+
+from robotframework_gemini.library import GeminiLibrary
+
+
+class BrowserGeminiLibrary(GeminiLibrary):
+    """Alias of :class:`robotframework_gemini.library.GeminiLibrary`."""
+
+
+__all__ = ["BrowserGeminiLibrary"]

robotframework_gemini-0.3.2/src/GeminiLibrary.py

@@ -0,0 +1,9 @@
+"""Top-level shim so ``Library    GeminiLibrary`` resolves via ``import GeminiLibrary``.
+
+Robot Framework entry points work at runtime; RobotCode and other tools often
+import the library name as a Python module first.
+"""
+
+from robotframework_gemini.library import GeminiLibrary
+
+__all__ = ["GeminiLibrary"]

{robotframework_gemini-0.3.0 → robotframework_gemini-0.3.2}/src/robotframework_gemini/__init__.py

@@ -18,4 +18,4 @@ __all__ = [
     "__version__",
 ]
 
-__version__ = "0.3.0"
+__version__ = "0.3.2"

{robotframework_gemini-0.3.0 → robotframework_gemini-0.3.2}/src/robotframework_gemini/client.py

@@ -33,7 +33,7 @@ class GeminiOrchestrator:
 
     Environment:
     - GEMINI_API_KEY for the API key (unless ``api_key`` is passed explicitly)
-    - GEMINI_MODEL for model id (e.g. gemini-2.0-flash); defaults to gemini-2.0-flash
+    - GEMINI_MODEL for model id (e.g. gemini-2.5-flash); defaults to gemini-2.5-flash
     """
 
     def __init__(
@@ -47,7 +47,7 @@ class GeminiOrchestrator:
             raise ValueError(
                 "Missing API key: set GEMINI_API_KEY (or pass api_key=...)"
             )
-        self.model = model or os.environ.get("GEMINI_MODEL") or "gemini-2.0-flash"
+        self.model = model or os.environ.get("GEMINI_MODEL") or "gemini-2.5-flash"
         self._client = genai.Client(api_key=key)
 
     def generate_from_text(self, prompt: str) -> str:

{robotframework_gemini-0.3.0 → robotframework_gemini-0.3.2}/src/robotframework_gemini/library.py

@@ -33,7 +33,12 @@ ensure_gemini_env_from_legacy()
 
 
 class GeminiLibrary:
-    """Keywords for Gemini text oracles and optional Browser screenshot capture."""
+    """Keywords for Gemini text oracles and optional Browser screenshot capture.
+
+    Import arguments:
+    - ``api_key`` — Gemini API key (falls back to ``GEMINI_API_KEY`` when omitted)
+    - ``model`` — model id (falls back to ``GEMINI_MODEL``, then ``gemini-2.5-flash``)
+    """
 
     ROBOT_LIBRARY_SCOPE = "GLOBAL"
 

robotframework_gemini-0.3.0/README.md

@@ -1,144 +0,0 @@
-# robotframework-gemini
-
-Biblioteca **Python** e **keywords do Robot Framework** para oráculos com **Google Gemini**: avaliação **só texto** (API, logs, JSON, etc.) ou **multimodal** com imagem (arquivo PNG ou captura do **Robot Framework Browser**).
-
-- **Multimodal**: envia o texto do prompt e a captura como `Part` em bytes (`google-genai`).
-- **Fluxo recomendado**: duas entradas — **contexto** (enquadramento do teste) e **avaliação** (critério ou pergunta objetiva).
-- **Browser opcional**: keywords de screenshot exigem `Library    Browser`; keywords de texto funcionam sem navegador.
-
-## Instalação
-
-```bash
-pip install robotframework-gemini
-```
-
-Com suporte a captura via Robot Framework Browser (Playwright):
-
-```bash
-pip install "robotframework-gemini[browser]"
-python -m pip install robotframework
-```
-
-Desenvolvimento local:
-
-```bash
-python -m pip install -e ".[dev]"
-```
-
-## Variáveis de ambiente
-
-| Variável          | Função                                      |
-|-------------------|---------------------------------------------|
-| `GEMINI_API_KEY`  | Chave da API Gemini (obrigatória se não passar `api_key` na Library) |
-| `GEMINI_MODEL`    | Modelo (ex.: `gemini-2.0-flash`). Se omitido, usa `gemini-2.0-flash`. |
-
-## Uso em Python (`GeminiOrchestrator`)
-
-```python
-from pathlib import Path
-from robotframework_gemini import GeminiOrchestrator
-
-orchestrator = GeminiOrchestrator()
-context = "Web dashboard with the 'Active' category filter applied."
-evaluation = "Do the visible list items match the selected category?"
-model_response = orchestrator.evaluate_with_image(context, evaluation, Path("screen.png"))
-```
-
-Para formato de saída restrito (ex.: Yes/No), use `extra_instructions`:
-
-```python
-model_response = orchestrator.evaluate_with_text(
-    context,
-    evaluation,
-    extra_instructions="Reply with one word only: Yes or No.",
-)
-```
-
-## Uso no Robot Framework
-
-> **Nota:** os exemplos usam `Set Variable` e `Catenate` em vez da keyword `VAR` (Robot Framework 7.0+) para manter retrocompatibilidade com versões anteriores do Robot Framework.
-
-### Só texto (sem Browser)
-
-```robot
-*** Settings ***
-Library    GeminiLibrary
-
-*** Keywords ***
-Validar resposta da API
-    ${context}=       Set Variable    {"status": "ok", "items": 3}
-    ${evaluation}=    Set Variable    O payload indica sucesso com itens?
-    ${model_response}=    Gemini Evaluate Text    ${context}    ${evaluation}
-    Log    ${model_response}
-```
-
-### Com captura de tela (Browser)
-
-Declare a biblioteca **Browser** antes de **Gemini**:
-
-```robot
-*** Settings ***
-Library    Browser
-Library    GeminiLibrary
-
-*** Keywords ***
-Checar tela por critério neutro
-    ${context}=       Set Variable    Lista filtrada por status Ativo.
-    ${evaluation}=    Set Variable    Todos os itens visíveis mostram status Ativo?
-    ${model_response}=    Gemini Evaluate With Screen    ${context}    ${evaluation}
-    Log    ${model_response}
-```
-
-Import explícito (equivalente):
-
-```robot
-Library    robotframework_gemini.library.GeminiLibrary
-```
-
-Com arquivo já salvo:
-
-```robot
-Browser.Take Screenshot    ${OUTPUT_DIR}/tela.png
-${model_response}=    Gemini Evaluate With Image File    ${context}    ${evaluation}    ${OUTPUT_DIR}/tela.png
-```
-
-Veredito via prompt (primeira linha) e nota 1–5:
-
-```robot
-${model_response}=    Gemini Evaluate With Screen    ${context}    ${evaluation}
-...    extra_instructions=Responda com uma palavra na primeira linha: Sim ou Não.
-${verdict}=    Get Line    ${model_response}    0
-Should Be Equal As Strings    ${verdict}    Sim
-
-# Nota 1–5: duas etapas (log da justificativa) ou atalho em uma linha
-${model_response}=    Gemini Evaluate Text Rating    ${context}    ${evaluation}
-${rating_score}=    Gemini Parse Rating    ${model_response}
-
-${rating_score}=    Gemini Evaluate Text Rating Score    ${context}    ${evaluation}
-```
-
-Detalhes das três keywords de nota: [`docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar`](docs/KEYWORDS.pt-BR.md#notas-15-três-keywords-quando-usar).
-
-Consulte também [`examples/demo_template.robot`](examples/demo_template.robot).
-
-## Documentação de Keywords
-
-- Português: [`docs/KEYWORDS.pt-BR.md`](docs/KEYWORDS.pt-BR.md)
-- English: [`docs/KEYWORDS.en.md`](docs/KEYWORDS.en.md)
-
-## Compatibilidade
-
-- `BrowserGeminiLibrary` permanece como alias de `GeminiLibrary` para suítes existentes.
-- Variáveis legadas (`LLM_API_KEY`, `LLM_API_KEY_LIA`, `LLM_LIA_MODEL`) são mapeadas para `GEMINI_*` ao importar o pacote.
-
-## Testes
-
-```bash
-pytest
-```
-
-Os testes usam mocks de `generate_content`; não há chamadas reais à API.
-
-## Licença
-
-MIT.