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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: robotframework-gemini
-Version: 0.3.0
+Version: 0.3.1
 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
@@ -59,12 +59,39 @@ 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-2.5-flash`). 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
+
+*** 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.
 
 ## Uso em Python (`GeminiOrchestrator`)
 
@@ -73,6 +100,8 @@ from pathlib import Path
 from robotframework_gemini import GeminiOrchestrator
 
 orchestrator = GeminiOrchestrator()
+# ou explicitamente:
+# orchestrator = GeminiOrchestrator(api_key="...", model="gemini-2.5-flash")
 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"))
@@ -123,12 +152,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 (Python / 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

{robotframework_gemini-0.3.0 → robotframework_gemini-0.3.1}/README.md

@@ -25,12 +25,39 @@ 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-2.5-flash`). 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
+
+*** 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.
 
 ## Uso em Python (`GeminiOrchestrator`)
 
@@ -39,6 +66,8 @@ from pathlib import Path
 from robotframework_gemini import GeminiOrchestrator
 
 orchestrator = GeminiOrchestrator()
+# ou explicitamente:
+# orchestrator = GeminiOrchestrator(api_key="...", model="gemini-2.5-flash")
 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"))
@@ -89,12 +118,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 (Python / 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

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

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "robotframework-gemini"
-version = "0.3.0"
+version = "0.3.1"
 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.1/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.1/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.1}/src/robotframework_gemini/__init__.py

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

{robotframework_gemini-0.3.0 → robotframework_gemini-0.3.1}/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.1}/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"