robotframework-plugins 2026.11.0.dev1__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- robotframework_plugins/__init__.py +14 -0
- robotframework_plugins/_assets/catalog.json +143 -0
- robotframework_plugins/_assets/plugins/rf-agentskills/.claude-plugin/plugin.json +25 -0
- robotframework_plugins/_assets/plugins/rf-agentskills/CHANGELOG.md +198 -0
- robotframework_plugins/_assets/plugins/rf-agentskills/README.md +27 -0
- robotframework_plugins/_assets/plugins/rf-agentskills/catalog.yaml +25 -0
- robotframework_plugins/_assets/plugins/rf-api/.claude-plugin/plugin.json +25 -0
- robotframework_plugins/_assets/plugins/rf-api/CHANGELOG.md +9 -0
- robotframework_plugins/_assets/plugins/rf-api/README.md +27 -0
- robotframework_plugins/_assets/plugins/rf-api/catalog.yaml +27 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/SKILL.md +110 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/assets/examples/authentication-patterns.robot +39 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/assets/examples/basic-crud.robot +46 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/assets/examples/file-upload.robot +28 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/assets/examples/session-handling.robot +48 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/authentication.md +58 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/install.md +10 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/request-options.md +90 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/response-validation.md +64 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-requests/references/troubleshooting.md +64 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/SKILL.md +119 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/assets/examples/basic-rest.robot +51 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/assets/examples/schema-validation.robot +38 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/assets/examples/schemas/user.json +10 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/authentication.md +61 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/install.md +11 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/json-handling.md +89 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/migrate-from-requests.md +15 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/schema-validation.md +85 -0
- robotframework_plugins/_assets/plugins/rf-api/skills/rf-restinstance/references/troubleshooting.md +68 -0
- robotframework_plugins/_assets/plugins/rf-core/.claude-plugin/plugin.json +19 -0
- robotframework_plugins/_assets/plugins/rf-core/CHANGELOG.md +11 -0
- robotframework_plugins/_assets/plugins/rf-core/README.md +38 -0
- robotframework_plugins/_assets/plugins/rf-core/agents/rf-debug-expert.md +104 -0
- robotframework_plugins/_assets/plugins/rf-core/agents/rf-migration-guide.md +73 -0
- robotframework_plugins/_assets/plugins/rf-core/agents/rf-test-architect.md +98 -0
- robotframework_plugins/_assets/plugins/rf-core/catalog.yaml +19 -0
- robotframework_plugins/_assets/plugins/rf-core/hooks/README.md +435 -0
- robotframework_plugins/_assets/plugins/rf-core/hooks/hooks.json +70 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/_hook_input.mjs +101 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/_pending_errors.mjs +65 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/_python_env.mjs +181 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/check_rf_environment.mjs +181 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/maybe_inject_rf_context.mjs +74 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/maybe_remind_robot_tests.mjs +108 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/report_pending_errors.mjs +72 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/rf_error_hints.mjs +126 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/validate_robot.mjs +509 -0
- robotframework_plugins/_assets/plugins/rf-core/scripts/validate_robot_project.mjs +103 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/SKILL.md +313 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/api.resource +30 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/calc.resource +23 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/embedded.resource +20 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/keywords.resource +26 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/resources/login.resource +10 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/01__keyword_driven.robot +15 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/02__data_driven.robot +10 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/03__templates.robot +17 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/04__bdd.robot +10 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/05__embedded.robot +13 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/__init__.robot +6 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/api/__init__.robot +7 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/api/users.robot +18 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/tests/env.robot +15 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/variables/common.py +11 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/variables/dev.yaml +3 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/assets/examples/variables/staging.yaml +3 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/arguments.md +139 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/control-structures.md +175 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/embedded-arguments.md +135 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/migration.md +90 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/resources-and-variable-files.md +127 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/styles.md +92 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/suites-and-init.md +96 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/tags-and-selection.md +104 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/templates.md +124 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/references/variables-and-scopes.md +129 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-language/scripts/rf_conventions.py +883 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/SKILL.md +216 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/ExampleLibrary.py +61 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/ResultListener.py +60 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/converters.py +48 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/converters.robot +20 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/example_library.robot +31 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/assets/examples/listener.robot +12 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/api-variants.md +291 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/communication.md +248 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/conversion.md +347 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/listeners.md +150 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/references/packaging-and-docs.md +155 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-python-library/scripts/check_library.py +842 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/SKILL.md +159 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/github-actions-robot.yml +32 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/gitignore.txt +22 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/pyproject.poetry.toml +28 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/pyproject.uv.toml +20 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/requirements.txt +9 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/robot.toml +16 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/smoke.robot +22 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/ci.md +61 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/cli-tools.md +33 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/libraries.md +47 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/poetry.md +77 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/project-layout.md +86 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/troubleshooting.md +73 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/uv.md +108 -0
- robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/references/venv-pip.md +71 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/codex/agents/rf-debug-expert.toml +103 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/codex/agents/rf-migration-guide.toml +72 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/codex/agents/rf-test-architect.toml +97 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/opencode/agents/rf-debug-expert.md +107 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/opencode/agents/rf-migration-guide.md +76 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/opencode/agents/rf-test-architect.md +101 -0
- robotframework_plugins/_assets/plugins/rf-core/variants/opencode/plugins/rf-core.js +93 -0
- robotframework_plugins/_assets/plugins/rf-desktop/.claude-plugin/plugin.json +24 -0
- robotframework_plugins/_assets/plugins/rf-desktop/CHANGELOG.md +9 -0
- robotframework_plugins/_assets/plugins/rf-desktop/README.md +26 -0
- robotframework_plugins/_assets/plugins/rf-desktop/catalog.yaml +23 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/SKILL.md +266 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/assets/examples/calculator.robot +45 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/assets/examples/mock-deterministic.robot +33 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/cli-and-inspector.md +82 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/install.md +14 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/keywords-reference.md +102 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/locators-and-queries.md +95 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/platform-setup.md +65 -0
- robotframework_plugins/_assets/plugins/rf-desktop/skills/rf-platynui/references/status-and-migration.md +41 -0
- robotframework_plugins/_assets/plugins/rf-mobile/.claude-plugin/plugin.json +24 -0
- robotframework_plugins/_assets/plugins/rf-mobile/CHANGELOG.md +9 -0
- robotframework_plugins/_assets/plugins/rf-mobile/README.md +26 -0
- robotframework_plugins/_assets/plugins/rf-mobile/catalog.yaml +23 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/SKILL.md +134 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/assets/examples/android-basic.robot +60 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/assets/examples/gestures-example.robot +59 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/assets/examples/hybrid-app.robot +54 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/assets/examples/ios-basic.robot +48 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/capabilities.md +117 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/gestures-touch.md +84 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/install.md +21 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/locators-mobile.md +74 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/platform-specific.md +105 -0
- robotframework_plugins/_assets/plugins/rf-mobile/skills/rf-appium/references/troubleshooting.md +70 -0
- robotframework_plugins/_assets/plugins/rf-web/.claude-plugin/plugin.json +25 -0
- robotframework_plugins/_assets/plugins/rf-web/CHANGELOG.md +9 -0
- robotframework_plugins/_assets/plugins/rf-web/README.md +27 -0
- robotframework_plugins/_assets/plugins/rf-web/catalog.yaml +27 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/SKILL.md +132 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/assets/examples/authentication-flow.robot +34 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/assets/examples/basic-web-test.robot +29 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/assets/examples/form-handling.robot +49 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/assets/examples/iframe-shadow-dom.robot +31 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/assertion-engine.md +79 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/authentication-storage.md +86 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/browser-context-page.md +110 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/downloads-uploads.md +51 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/iframes-shadow-dom.md +67 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/install.md +67 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/locators.md +83 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/migrate-from-selenium.md +22 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-browser/references/troubleshooting.md +100 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/SKILL.md +123 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/assets/examples/basic-web-test.robot +64 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/assets/examples/multi-window.robot +55 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/assets/examples/wait-patterns.robot +53 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/browser-setup.md +103 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/frames-windows.md +84 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/install.md +12 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/javascript-execution.md +65 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/locators.md +86 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/troubleshooting.md +122 -0
- robotframework_plugins/_assets/plugins/rf-web/skills/rf-selenium/references/waiting-strategies.md +84 -0
- robotframework_plugins/_assets.py +120 -0
- robotframework_plugins/_catalog.py +123 -0
- robotframework_plugins/_snapshot.py +230 -0
- robotframework_plugins/adapters/__init__.py +53 -0
- robotframework_plugins/adapters/_base.py +400 -0
- robotframework_plugins/adapters/claude_code.py +312 -0
- robotframework_plugins/adapters/claude_desktop.py +129 -0
- robotframework_plugins/adapters/codex.py +276 -0
- robotframework_plugins/adapters/copilot.py +87 -0
- robotframework_plugins/adapters/cursor.py +295 -0
- robotframework_plugins/adapters/goose.py +240 -0
- robotframework_plugins/adapters/opencode.py +170 -0
- robotframework_plugins/bundle.py +85 -0
- robotframework_plugins/cli.py +1311 -0
- robotframework_plugins/detect.py +121 -0
- robotframework_plugins/manifest.py +338 -0
- robotframework_plugins/py.typed +0 -0
- robotframework_plugins/skillzip.py +39 -0
- robotframework_plugins/transforms.py +725 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/METADATA +178 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/RECORD +195 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/WHEEL +4 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/entry_points.txt +2 -0
- robotframework_plugins-2026.11.0.dev1.dist-info/licenses/LICENSE +201 -0
|
@@ -0,0 +1,159 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: rf-setup
|
|
3
|
+
description: "Use first, before reading pyproject.toml, to install or fix Robot Framework and libraries (uv, pip, venv)."
|
|
4
|
+
license: Apache-2.0
|
|
5
|
+
compatibility: Requires one of uv (preferred), Python 3.10+ with venv and pip, or Poetry 1.8+; network access to PyPI. Installs robotcode[all]>=2.8 into the project environment, which the other Robot Framework skills and the rf-core hooks require.
|
|
6
|
+
metadata:
|
|
7
|
+
author: manykarim
|
|
8
|
+
version: "1.0.0"
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Robot Framework Setup Skill
|
|
12
|
+
|
|
13
|
+
## When to use
|
|
14
|
+
|
|
15
|
+
Load this skill first, before reading pyproject.toml or answering from memory, when Robot Framework, a test library or its tooling has to be installed, added as a dependency or repaired:
|
|
16
|
+
|
|
17
|
+
- the project's tool: uv by default, venv + pip, or Poetry; Python version floors;
|
|
18
|
+
- which package a test library needs, and which skill and plugin give its post-install steps;
|
|
19
|
+
- a new Robot Framework project or CI setup;
|
|
20
|
+
- `ModuleNotFoundError` / No module named '...', `robot: command not found` after installing, externally-managed-environment, a wrong interpreter.
|
|
21
|
+
|
|
22
|
+
Not this skill: when the user asks for a test to be written or fixed, use the library skills (for example `rf-browser` in plugin `rf-web`, `rf-requests` in plugin `rf-api`), even if the library is not installed yet.
|
|
23
|
+
|
|
24
|
+
## Quick Reference
|
|
25
|
+
|
|
26
|
+
Install Robot Framework **into the project's own environment**, never into the system Python, and verify it before writing tests. Every other Robot Framework skill assumes this setup works.
|
|
27
|
+
|
|
28
|
+
Recipes verified on 2026-09-26 with uv 0.9.26, Poetry 2.4.1, pip 26, Python 3.12, Robot Framework 7.5.
|
|
29
|
+
|
|
30
|
+
## Step 1: Use the tool the project already uses
|
|
31
|
+
|
|
32
|
+
Look at the project root before installing anything:
|
|
33
|
+
|
|
34
|
+
| You find | Tool | Reference |
|
|
35
|
+
|---|---|---|
|
|
36
|
+
| `uv.lock` (or `[tool.uv]` / `[dependency-groups]` with a uv workflow) | **uv** | `references/uv.md` |
|
|
37
|
+
| `poetry.lock` or `[tool.poetry]` in `pyproject.toml` | **Poetry** | `references/poetry.md` |
|
|
38
|
+
| `requirements*.txt`, or an existing `.venv/` without a lockfile | **venv + pip** | `references/venv-pip.md` |
|
|
39
|
+
| Nothing (new project) | **uv** (default) | `references/uv.md` |
|
|
40
|
+
|
|
41
|
+
Don't switch a project to another tool unless the user asks. Converting `requirements.txt` to uv is shown in `references/uv.md`.
|
|
42
|
+
|
|
43
|
+
## Step 2: Pick the Python version
|
|
44
|
+
|
|
45
|
+
**Recommend Python 3.12.** It satisfies every library the plugins of this marketplace cover. Floors checked on PyPI on 2026-09-26:
|
|
46
|
+
|
|
47
|
+
| Package | Python |
|
|
48
|
+
|---|---|
|
|
49
|
+
| robotframework 7.5 | ≥ 3.8 |
|
|
50
|
+
| robotframework-browser 20.x, robotframework-seleniumlibrary 6.9, robotcode 2.8, robotframework-robocop 9.x | ≥ 3.10 |
|
|
51
|
+
| RESTinstance 1.8 | ≥ 3.11 |
|
|
52
|
+
| robotframework-PlatynUI (new_core pre-release) | ≥ 3.12 |
|
|
53
|
+
|
|
54
|
+
On Debian/Ubuntu, `python3.12 -m venv` needs the `python3.12-venv` package. uv avoids this by installing its own Python (`uv python install 3.12`).
|
|
55
|
+
|
|
56
|
+
## Step 3: Install (new project with uv)
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
uv init --bare --python 3.12 # pyproject.toml only; --python avoids requires-python >= newest
|
|
60
|
+
uv python pin 3.12 # writes .python-version; without it uv may pick a newer Python
|
|
61
|
+
uv add robotframework # then the test libraries, Step 4
|
|
62
|
+
uv add --dev "robotcode[all]>=2.8" # required: robotcode CLI (+ Robocop), see below
|
|
63
|
+
uv run robot --version # "Robot Framework 7.5 (Python 3.12…)"; exit code 251 is normal here
|
|
64
|
+
uv run robotcode --version # "robotcode, version 2.8.…"
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Commit `pyproject.toml`, `uv.lock` and `.python-version`. On another machine or in CI: `uv sync --locked`.
|
|
68
|
+
|
|
69
|
+
venv + pip and Poetry equivalents: `references/venv-pip.md`, `references/poetry.md`.
|
|
70
|
+
|
|
71
|
+
## Required: robotcode in the project environment
|
|
72
|
+
|
|
73
|
+
The other Robot Framework skills and the rf-core validation hooks run the robotcode CLI (`robotcode doc`, `robotcode analyze code`, `robotcode results`, `robotcode robot-debug`). Install it in every new or repaired setup, right after Robot Framework, with the tool the project uses:
|
|
74
|
+
|
|
75
|
+
| Tool | Command |
|
|
76
|
+
|---|---|
|
|
77
|
+
| uv | `uv add --dev "robotcode[all]>=2.8"` |
|
|
78
|
+
| Poetry | `poetry add --group dev "robotcode[all]>=2.8"` |
|
|
79
|
+
| venv + pip | `pip install "robotcode[all]>=2.8"` (venv active; also add it to `requirements-dev.txt`) |
|
|
80
|
+
|
|
81
|
+
- **Why `[all]`:** the base `robotcode` package only has `config` and `profiles`. The skills need the `runner` extra (`robot`, `discover`, `results`, `libdoc`), `analyze` (`analyze code`) and `repl` (`doc`, `repl`, `robot-debug`), and the hooks need Robocop. Only `[all]` brings all of them.
|
|
82
|
+
- **Why ≥ 2.8:** `robotcode doc` (keyword lookup) first ships in 2.8. For an older install, run the same command again: it raises the lower bound and upgrades robotcode.
|
|
83
|
+
- **CI that only runs tests** can install `robotcode[runner]` instead.
|
|
84
|
+
- Verify with `uv run robotcode --version` and `uv run robotcode discover info` (the Python and Robot Framework it reports must be the project's).
|
|
85
|
+
- For how to drive robotcode (running, discovery, keyword docs, results, debugging), install the robotcode plugin from `robotcodedev/robotframework-agent-plugins` next to rf-core.
|
|
86
|
+
|
|
87
|
+
## Step 4: Add libraries
|
|
88
|
+
|
|
89
|
+
One row per library a plugin of this marketplace covers. The library's skill has the full post-install steps and their verification, in its own `install.md` reference. If that skill isn't available, suggest installing its plugin instead of answering from memory.
|
|
90
|
+
|
|
91
|
+
| Library | Install (uv form) | After installing | Skill (plugin) |
|
|
92
|
+
|---|---|---|---|
|
|
93
|
+
| Browser (Playwright) | `uv add "robotframework-browser[bb]"` | `[bb]` BrowserBatteries with `rfbrowser install`, or Node.js LTS with plain `robotframework-browser` and `rfbrowser init` | `rf-browser` (plugin `rf-web`) |
|
|
94
|
+
| SeleniumLibrary | `uv add robotframework-seleniumlibrary` | A browser; Selenium Manager resolves the driver | `rf-selenium` (plugin `rf-web`) |
|
|
95
|
+
| AppiumLibrary | `uv add robotframework-appiumlibrary` | Appium server and platform drivers via npm | `rf-appium` (plugin `rf-mobile`) |
|
|
96
|
+
| RequestsLibrary | `uv add robotframework-requests` | Nothing | `rf-requests` (plugin `rf-api`) |
|
|
97
|
+
| RESTinstance | `uv add RESTinstance` | Python ≥ 3.11 | `rf-restinstance` (plugin `rf-api`) |
|
|
98
|
+
| PlatynUI (preview) | `uv add --prerelease allow robotframework-PlatynUI` | Pre-release install; Python ≥ 3.12 | `rf-platynui` (plugin `rf-desktop`) |
|
|
99
|
+
|
|
100
|
+
Poetry and pip forms, robotcode, and other packages: `references/libraries.md`.
|
|
101
|
+
|
|
102
|
+
## ⚠️ Never install test libraries globally
|
|
103
|
+
|
|
104
|
+
- No `sudo pip install`, no `pip install --break-system-packages`, no `pip install --user` for project dependencies.
|
|
105
|
+
- **Don't use `pipx`, `uvx` or `uv tool` for test libraries or robotcode.** Those create isolated environments that `robot` in the project can't import from. They are only for standalone CLIs such as `robotframework-plugins` (see `references/cli-tools.md`).
|
|
106
|
+
- Run tools through the project environment: `uv run …`, `poetry run …`, or `.venv/bin/python -m …` / an activated venv.
|
|
107
|
+
|
|
108
|
+
## Step 5: Verify before handing over
|
|
109
|
+
|
|
110
|
+
```bash
|
|
111
|
+
uv run robot --version # right interpreter? (poetry run … / .venv/bin/python -m robot …)
|
|
112
|
+
uv run robotcode discover info # Python, RF and robotcode actually used
|
|
113
|
+
uv run robot --outputdir results tests/smoke.robot # smoke test (assets/examples/smoke.robot)
|
|
114
|
+
uv run robotcode analyze code tests # all suites parse, imports and keywords resolve
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
`robotcode analyze code` catches missing libraries, misspelled keywords and wrong arguments without running anything, and it reads `robot.toml`. Report the versions from `robotcode discover info` to the user.
|
|
118
|
+
|
|
119
|
+
## Project layout
|
|
120
|
+
|
|
121
|
+
```text
|
|
122
|
+
my-tests/
|
|
123
|
+
pyproject.toml uv.lock .python-version # or poetry.lock / requirements.txt
|
|
124
|
+
robot.toml # shared robot options + profiles
|
|
125
|
+
tests/ resources/ libraries/ variables/
|
|
126
|
+
results/ # output (gitignored)
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
Details and example files: `references/project-layout.md`, `assets/examples/`.
|
|
130
|
+
|
|
131
|
+
## When to Load Additional References
|
|
132
|
+
|
|
133
|
+
| Need | Reference File |
|
|
134
|
+
|------|----------------|
|
|
135
|
+
| uv: init, pin, add, lock, sync, upgrade, adopt requirements.txt | `references/uv.md` |
|
|
136
|
+
| venv + pip: create, activate (bash/PowerShell/cmd), requirements, pin | `references/venv-pip.md` |
|
|
137
|
+
| Poetry: non-package mode, groups, run, install from lock | `references/poetry.md` |
|
|
138
|
+
| Standalone CLIs with `uv tool` / `uvx` / `pipx` | `references/cli-tools.md` |
|
|
139
|
+
| Poetry/pip forms, robotcode, other packages; where each library's install steps live | `references/libraries.md` |
|
|
140
|
+
| Folder structure, `robot.toml`, `.gitignore` | `references/project-layout.md` |
|
|
141
|
+
| GitHub Actions and other CI | `references/ci.md` |
|
|
142
|
+
| Errors: wrong interpreter, PEP 668, old Python, PowerShell policy | `references/troubleshooting.md` |
|
|
143
|
+
|
|
144
|
+
Examples in `assets/examples/`: `pyproject.uv.toml`, `pyproject.poetry.toml`, `requirements.txt`, `robot.toml`, `gitignore.txt`, `smoke.robot`, `github-actions-robot.yml`.
|
|
145
|
+
|
|
146
|
+
## Companion Skills
|
|
147
|
+
|
|
148
|
+
| Need | Skill |
|
|
149
|
+
|------|-------|
|
|
150
|
+
| Web UI tests with Browser Library (Playwright) | `rf-browser` (plugin `rf-web`) |
|
|
151
|
+
| Web UI tests with SeleniumLibrary (WebDriver) | `rf-selenium` (plugin `rf-web`) |
|
|
152
|
+
| Mobile app tests with AppiumLibrary | `rf-appium` (plugin `rf-mobile`) |
|
|
153
|
+
| API tests with RequestsLibrary | `rf-requests` (plugin `rf-api`) |
|
|
154
|
+
| API tests with RESTinstance / JSON Schema | `rf-restinstance` (plugin `rf-api`) |
|
|
155
|
+
| Native desktop tests with PlatynUI | `rf-platynui` (plugin `rf-desktop`) |
|
|
156
|
+
| Write tests, suites, user keywords, resources and variables in Robot Framework syntax | `rf-language` |
|
|
157
|
+
| Write or fix a Python keyword library or listener | `rf-python-library` |
|
|
158
|
+
|
|
159
|
+
For running, discovering, keyword documentation, result analysis and debugging with the robotcode CLI, use the `robotcode` skill of the robotcode plugin (`robotcode@robotframework-agent-plugins`).
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# Copy to .github/workflows/robot.yml. Assumes a uv project (pyproject.toml, uv.lock, .python-version).
|
|
2
|
+
name: Robot Framework
|
|
3
|
+
|
|
4
|
+
on:
|
|
5
|
+
push:
|
|
6
|
+
pull_request:
|
|
7
|
+
|
|
8
|
+
jobs:
|
|
9
|
+
robot:
|
|
10
|
+
runs-on: ubuntu-latest
|
|
11
|
+
steps:
|
|
12
|
+
- uses: actions/checkout@v7
|
|
13
|
+
|
|
14
|
+
- uses: astral-sh/setup-uv@v10
|
|
15
|
+
with:
|
|
16
|
+
enable-cache: true
|
|
17
|
+
|
|
18
|
+
- name: Install dependencies
|
|
19
|
+
run: uv sync --locked
|
|
20
|
+
|
|
21
|
+
# Add each test library's post-install step here, as its skill's
|
|
22
|
+
# references/install.md gives it (Browser: rf-browser, plugin rf-web).
|
|
23
|
+
|
|
24
|
+
- name: Run tests
|
|
25
|
+
run: uv run robot --outputdir results tests
|
|
26
|
+
|
|
27
|
+
- name: Upload results
|
|
28
|
+
if: always()
|
|
29
|
+
uses: actions/upload-artifact@v7
|
|
30
|
+
with:
|
|
31
|
+
name: robot-results
|
|
32
|
+
path: results/
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Copy to .gitignore in the project root.
|
|
2
|
+
# Environments
|
|
3
|
+
.venv/
|
|
4
|
+
__pycache__/
|
|
5
|
+
|
|
6
|
+
# Robot Framework output
|
|
7
|
+
results/
|
|
8
|
+
output.xml
|
|
9
|
+
log.html
|
|
10
|
+
report.html
|
|
11
|
+
*.xunit.xml
|
|
12
|
+
|
|
13
|
+
# Browser / Playwright
|
|
14
|
+
playwright-log.txt
|
|
15
|
+
browser/
|
|
16
|
+
|
|
17
|
+
# robotcode and pabot
|
|
18
|
+
.robotcode_cache/
|
|
19
|
+
.pabotsuitenames
|
|
20
|
+
pabot_results/
|
|
21
|
+
|
|
22
|
+
# Keep: uv.lock, poetry.lock, .python-version, requirements*.txt
|
robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/pyproject.poetry.toml
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# pyproject.toml for a Robot Framework test project managed with Poetry 2.x.
|
|
2
|
+
# Created with:
|
|
3
|
+
# poetry init --no-interaction --python ">=3.12,<3.14"
|
|
4
|
+
# poetry add robotframework robotframework-requests
|
|
5
|
+
# poetry add --group dev "robotcode[all]>=2.8"
|
|
6
|
+
# Reproduce elsewhere with: poetry install
|
|
7
|
+
[project]
|
|
8
|
+
name = "my-tests"
|
|
9
|
+
version = "0.1.0"
|
|
10
|
+
description = "Robot Framework tests"
|
|
11
|
+
requires-python = ">=3.12,<3.14"
|
|
12
|
+
dependencies = [
|
|
13
|
+
"robotframework (>=7.5,<8.0)",
|
|
14
|
+
"robotframework-requests (>=0.9.7,<0.10.0)"
|
|
15
|
+
]
|
|
16
|
+
|
|
17
|
+
[tool.poetry]
|
|
18
|
+
# A test project is not a package to build; without this `poetry install` fails.
|
|
19
|
+
package-mode = false
|
|
20
|
+
|
|
21
|
+
[build-system]
|
|
22
|
+
requires = ["poetry-core>=2.0.0,<3.0.0"]
|
|
23
|
+
build-backend = "poetry.core.masonry.api"
|
|
24
|
+
|
|
25
|
+
[dependency-groups]
|
|
26
|
+
dev = [
|
|
27
|
+
"robotcode[all] (>=2.8.0,<3.0.0)"
|
|
28
|
+
]
|
robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/pyproject.uv.toml
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# pyproject.toml for a Robot Framework test project managed with uv.
|
|
2
|
+
# Created with:
|
|
3
|
+
# uv init --bare --python 3.12 && uv python pin 3.12
|
|
4
|
+
# uv add robotframework <test libraries> # see the Step 4 table in rf-setup
|
|
5
|
+
# uv add --dev "robotcode[all]>=2.8"
|
|
6
|
+
# Reproduce elsewhere with: uv sync --locked
|
|
7
|
+
[project]
|
|
8
|
+
name = "my-tests"
|
|
9
|
+
version = "0.1.0"
|
|
10
|
+
requires-python = ">=3.12"
|
|
11
|
+
dependencies = [
|
|
12
|
+
"robotframework>=7.5",
|
|
13
|
+
"robotframework-requests>=0.9.7",
|
|
14
|
+
# "robotframework-browser[bb]>=20.5.0", # post-install: rf-browser (plugin rf-web)
|
|
15
|
+
]
|
|
16
|
+
|
|
17
|
+
[dependency-groups]
|
|
18
|
+
dev = [
|
|
19
|
+
"robotcode[all]>=2.8.0", # includes Robocop
|
|
20
|
+
]
|
robotframework_plugins/_assets/plugins/rf-core/skills/rf-setup/assets/examples/requirements.txt
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Robot Framework and test libraries for this project.
|
|
2
|
+
# Install into the project venv: python -m pip install -r requirements.txt
|
|
3
|
+
robotframework>=7.3
|
|
4
|
+
robotframework-requests>=0.9.7
|
|
5
|
+
# robotframework-browser[bb]>=20.0 # web UI testing (post-install: rf-browser, plugin rf-web)
|
|
6
|
+
# robotframework-seleniumlibrary>=6.7
|
|
7
|
+
|
|
8
|
+
# Developer tools (required by rf-core; [all] includes Robocop)
|
|
9
|
+
robotcode[all]>=2.8
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
# robot.toml: shared robot options, read by robotcode (`robotcode robot`, IDE, discover, …).
|
|
2
|
+
# Plain `robot` ignores this file; see references/project-layout.md.
|
|
3
|
+
output-dir = "results"
|
|
4
|
+
python-path = ["resources", "libraries"]
|
|
5
|
+
paths = ["tests"]
|
|
6
|
+
|
|
7
|
+
[variables]
|
|
8
|
+
HEADLESS = "true"
|
|
9
|
+
|
|
10
|
+
[profiles.headed]
|
|
11
|
+
description = "Show the browser window"
|
|
12
|
+
variables = { HEADLESS = "false" }
|
|
13
|
+
|
|
14
|
+
[profiles.ci]
|
|
15
|
+
description = "CI run"
|
|
16
|
+
output-dir = "results/ci"
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
*** Settings ***
|
|
2
|
+
Documentation Smoke test for a fresh Robot Framework setup.
|
|
3
|
+
... Uses only standard libraries, so it passes on any correct install.
|
|
4
|
+
Library Collections
|
|
5
|
+
Library OperatingSystem
|
|
6
|
+
|
|
7
|
+
*** Test Cases ***
|
|
8
|
+
Robot Framework Runs
|
|
9
|
+
${version}= Evaluate robot.version.get_version() modules=robot
|
|
10
|
+
Log To Console Robot Framework ${version}
|
|
11
|
+
Should Not Be Empty ${version}
|
|
12
|
+
|
|
13
|
+
Python Interpreter Is The Project Environment
|
|
14
|
+
${exe}= Evaluate sys.executable modules=sys
|
|
15
|
+
Log To Console Python: ${exe}
|
|
16
|
+
Should Not Be Empty ${exe}
|
|
17
|
+
|
|
18
|
+
Standard Libraries Work
|
|
19
|
+
${items}= Create List a b
|
|
20
|
+
Append To List ${items} c
|
|
21
|
+
Length Should Be ${items} 3
|
|
22
|
+
Directory Should Exist ${CURDIR}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# CI Setup
|
|
2
|
+
|
|
3
|
+
The CI job should rebuild the same environment from the lockfile, install any library post-install steps, run the suites, and keep the results.
|
|
4
|
+
|
|
5
|
+
## GitHub Actions with uv
|
|
6
|
+
|
|
7
|
+
Full file: `assets/examples/github-actions-robot.yml` (copy to `.github/workflows/robot.yml`).
|
|
8
|
+
|
|
9
|
+
```yaml
|
|
10
|
+
name: Robot Framework
|
|
11
|
+
on: [push, pull_request]
|
|
12
|
+
|
|
13
|
+
jobs:
|
|
14
|
+
robot:
|
|
15
|
+
runs-on: ubuntu-latest
|
|
16
|
+
steps:
|
|
17
|
+
- uses: actions/checkout@v7
|
|
18
|
+
- uses: astral-sh/setup-uv@v10
|
|
19
|
+
with:
|
|
20
|
+
enable-cache: true
|
|
21
|
+
- name: Install dependencies
|
|
22
|
+
run: uv sync --locked # Python version from .python-version
|
|
23
|
+
# Add the post-install step of each test library here, as its skill's
|
|
24
|
+
# references/install.md gives it (for example the Browser browsers).
|
|
25
|
+
- name: Run tests
|
|
26
|
+
run: uv run robot --outputdir results tests
|
|
27
|
+
- name: Upload results
|
|
28
|
+
if: always()
|
|
29
|
+
uses: actions/upload-artifact@v7
|
|
30
|
+
with:
|
|
31
|
+
name: robot-results
|
|
32
|
+
path: results/
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
Notes:
|
|
36
|
+
|
|
37
|
+
- `uv sync --locked` fails when `uv.lock` is out of date. That's what you want in CI.
|
|
38
|
+
- Files a library's post-install step puts inside `.venv` (such as browser binaries) must be installed in every job: the uv cache doesn't cover them. The library's skill gives the CI step.
|
|
39
|
+
- Headed browsers in CI need a virtual display: `xvfb-run -a uv run robot …` (Ubuntu runners have `xvfb`), or run headless.
|
|
40
|
+
- Robot's exit code is the number of failed tests, so a failing test fails the step. `if: always()` still uploads the results.
|
|
41
|
+
- With robotcode in the dev group, `uv run robotcode -p ci robot` uses a `ci` profile from `robot.toml`, and `uv run robotcode analyze code --output-format github` adds annotations to the PR. A job that only runs tests can install `robotcode[runner]` instead of `[all]`.
|
|
42
|
+
|
|
43
|
+
## Poetry or pip in CI
|
|
44
|
+
|
|
45
|
+
```yaml
|
|
46
|
+
- uses: actions/setup-python@v7
|
|
47
|
+
with:
|
|
48
|
+
python-version: "3.12"
|
|
49
|
+
# Poetry
|
|
50
|
+
- run: pipx install poetry && poetry install
|
|
51
|
+
- run: poetry run robot --outputdir results tests
|
|
52
|
+
# or pip
|
|
53
|
+
- run: python -m pip install -r requirements.lock.txt
|
|
54
|
+
- run: python -m robot --outputdir results tests
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
On CI runners the job's fresh Python is already isolated, so plain `python -m pip install` is fine there. Still pin via the lock file.
|
|
58
|
+
|
|
59
|
+
## Other CI systems
|
|
60
|
+
|
|
61
|
+
The steps are the same everywhere: install uv (`curl -LsSf https://astral.sh/uv/install.sh | sh`), `uv sync --locked`, library post-install, `uv run robot …`, archive `results/`.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Standalone CLI Tools: `uv tool`, `uvx`, `pipx`
|
|
2
|
+
|
|
3
|
+
`uv tool install`, `uvx` and `pipx` put a command-line tool into **its own isolated environment** and link the command onto PATH. That is right for tools that don't need to import your test libraries, and wrong for everything `robot` needs at run time.
|
|
4
|
+
|
|
5
|
+
| Use a tool environment for | Keep in the project environment |
|
|
6
|
+
|---|---|
|
|
7
|
+
| `robotframework-plugins` (the installer for these skills) | `robotframework` |
|
|
8
|
+
| `uv` itself (`pipx install uv`) | Every test library (Browser, SeleniumLibrary, RequestsLibrary, …) |
|
|
9
|
+
| optional CLIs a library skill names (it gives the command) | `robotcode[all]` (it imports your libraries for `doc`, `discover`, `analyze`; never `uvx robotcode`) |
|
|
10
|
+
| One-off commands: `uvx robotframework-plugins install` | `robocop` (comes with `robotcode[all]`; uses the project's RF version) |
|
|
11
|
+
|
|
12
|
+
Why: a library installed with `pipx install robotframework-browser` lives in `~/.local/pipx/venvs/robotframework-browser/`. Your project's `robot` can't import it, so you get `No module named 'Browser'` or `Importing library 'Browser' failed`.
|
|
13
|
+
|
|
14
|
+
## Commands
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
# uv
|
|
18
|
+
uv tool install robotframework-plugins # persistent, on PATH
|
|
19
|
+
uvx robotframework-plugins install # run once without installing
|
|
20
|
+
uv tool upgrade robotframework-plugins
|
|
21
|
+
uv tool list
|
|
22
|
+
|
|
23
|
+
# pipx
|
|
24
|
+
pipx install robotframework-plugins
|
|
25
|
+
pipx run robotframework-plugins install
|
|
26
|
+
pipx upgrade robotframework-plugins
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Pre-release tools need an opt-in: `uv tool install --prerelease allow <tool>`, `pipx install --pip-args=--pre <tool>`.
|
|
30
|
+
|
|
31
|
+
## Hooks and the installer
|
|
32
|
+
|
|
33
|
+
The rf-core hooks (validation, environment check) run Python. The installer records the interpreter it was installed with in `python_runtime.json`, and the hooks prefer it. If hooks report "robotframework not installed" although the project has it, the hooks are using a different interpreter than the project. Install `robotcode[all]` into the project env (see the robotcode step in SKILL.md), or rerun the installer from inside the project env: `uv run robotframework-plugins install` after `uv add --dev robotframework-plugins`.
|
|
@@ -0,0 +1,47 @@
|
|
|
1
|
+
# Installing Test Libraries and Tools
|
|
2
|
+
|
|
3
|
+
Package names and where each library's install steps live. Versions and floors checked on PyPI 2026-09-26. Commands are shown in the uv form; the equivalents are:
|
|
4
|
+
|
|
5
|
+
| uv | Poetry | venv + pip |
|
|
6
|
+
|---|---|---|
|
|
7
|
+
| `uv add <pkg>` | `poetry add <pkg>` | `.venv/bin/python -m pip install <pkg>` (+ add it to `requirements.txt`) |
|
|
8
|
+
| `uv add --dev <pkg>` | `poetry add --group dev <pkg>` | same, in `requirements-dev.txt` |
|
|
9
|
+
| `uv run <cmd>` | `poetry run <cmd>` | `.venv/bin/<cmd>` or activated venv |
|
|
10
|
+
|
|
11
|
+
A quick import check works for any library: `uv run python -c "import <Module>"` (module names below).
|
|
12
|
+
|
|
13
|
+
## Robot Framework
|
|
14
|
+
|
|
15
|
+
- Package `robotframework` (7.5, Python ≥ 3.8). Module `robot`.
|
|
16
|
+
- Verify: `uv run robot --version` (exit code 251 is normal).
|
|
17
|
+
|
|
18
|
+
## Test libraries
|
|
19
|
+
|
|
20
|
+
Each library's skill has its install command, post-install steps and verification, in its `references/install.md`. If the skill isn't available, suggest installing its plugin.
|
|
21
|
+
|
|
22
|
+
| Library | Package | Module | Skill (plugin) |
|
|
23
|
+
|---|---|---|---|
|
|
24
|
+
| Browser (Playwright) | `robotframework-browser` | `Browser` | `rf-browser` (plugin `rf-web`) |
|
|
25
|
+
| SeleniumLibrary | `robotframework-seleniumlibrary` | `SeleniumLibrary` | `rf-selenium` (plugin `rf-web`) |
|
|
26
|
+
| AppiumLibrary | `robotframework-appiumlibrary` | `AppiumLibrary` | `rf-appium` (plugin `rf-mobile`) |
|
|
27
|
+
| RequestsLibrary | `robotframework-requests` | `RequestsLibrary` | `rf-requests` (plugin `rf-api`) |
|
|
28
|
+
| RESTinstance | `RESTinstance` | `REST` | `rf-restinstance` (plugin `rf-api`) |
|
|
29
|
+
| PlatynUI (preview) | `robotframework-PlatynUI` | `PlatynUI` | `rf-platynui` (plugin `rf-desktop`) |
|
|
30
|
+
|
|
31
|
+
## robotcode (required)
|
|
32
|
+
|
|
33
|
+
- Package `robotcode[all]>=2.8` (Python ≥ 3.10). Install as a **dev dependency in the project env**, never with `pipx`, `uvx` or `uv tool`: it imports your libraries. The `[all]` extra also installs Robocop (`robotframework-robocop>=6`), so Robocop needs no separate install.
|
|
34
|
+
- uv: `uv add --dev "robotcode[all]>=2.8"` · Poetry: `poetry add --group dev "robotcode[all]>=2.8"` · pip: `pip install "robotcode[all]>=2.8"`.
|
|
35
|
+
- Verify: `uv run robotcode discover info` shows the project's `.venv` Python; `uv run robocop --version` works.
|
|
36
|
+
- The rf-core validation hooks run `robotcode analyze code` (errors) and Robocop (deprecations, formatting) from the project environment.
|
|
37
|
+
|
|
38
|
+
## Other common packages
|
|
39
|
+
|
|
40
|
+
| Package | Use |
|
|
41
|
+
|---|---|
|
|
42
|
+
| `robotframework-pabot` | Parallel execution (`pabot` command) |
|
|
43
|
+
| `robotframework-datadriver` | Data-driven tests from CSV/Excel |
|
|
44
|
+
| `robotframework-databaselibrary` | SQL databases (plus a DB driver package) |
|
|
45
|
+
| `robotframework-sshlibrary` | SSH / SFTP |
|
|
46
|
+
|
|
47
|
+
Standard libraries (BuiltIn, Collections, String, OperatingSystem, Process, DateTime, XML, …) ship with Robot Framework. Nothing to install.
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
# Setup with Poetry
|
|
2
|
+
|
|
3
|
+
Use this when the project has `poetry.lock` or `[tool.poetry]`. Verified with Poetry 2.4.1.
|
|
4
|
+
|
|
5
|
+
## New project
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
mkdir my-tests && cd my-tests
|
|
9
|
+
poetry init --no-interaction --python ">=3.12,<3.14"
|
|
10
|
+
poetry env use 3.12 # or a full interpreter path
|
|
11
|
+
poetry add robotframework robotframework-requests
|
|
12
|
+
poetry add --group dev "robotcode[all]>=2.8" # robotcode CLI + Robocop
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Then add **non-package mode** to `pyproject.toml`. A test project is not a Python package to build:
|
|
16
|
+
|
|
17
|
+
```toml
|
|
18
|
+
[tool.poetry]
|
|
19
|
+
package-mode = false
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Without it, `poetry install` tries to install the project itself and fails with "If you want to use Poetry only for dependency management but not for packaging, you can disable package mode…". `package-mode` needs Poetry ≥ 1.8; on older Poetry use `poetry install --no-root`.
|
|
23
|
+
|
|
24
|
+
Poetry 2 writes a PEP 621 `[project]` table and a `[dependency-groups]` dev group (see `assets/examples/pyproject.poetry.toml`):
|
|
25
|
+
|
|
26
|
+
```toml
|
|
27
|
+
[project]
|
|
28
|
+
name = "my-tests"
|
|
29
|
+
version = "0.1.0"
|
|
30
|
+
requires-python = ">=3.12,<3.14"
|
|
31
|
+
dependencies = [
|
|
32
|
+
"robotframework (>=7.5,<8.0)",
|
|
33
|
+
"robotframework-requests (>=0.9.7,<0.10.0)"
|
|
34
|
+
]
|
|
35
|
+
|
|
36
|
+
[tool.poetry]
|
|
37
|
+
package-mode = false
|
|
38
|
+
|
|
39
|
+
[dependency-groups]
|
|
40
|
+
dev = [
|
|
41
|
+
"robotcode[all] (>=2.8.0,<3.0.0)"
|
|
42
|
+
]
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
`poetry init` fills in `authors` from your git config. Remove it or keep it, as you like.
|
|
46
|
+
|
|
47
|
+
## Venv location
|
|
48
|
+
|
|
49
|
+
Poetry keeps venvs in its cache by default. Many teams prefer `.venv/` in the project, so that IDEs and robotcode find it:
|
|
50
|
+
|
|
51
|
+
```bash
|
|
52
|
+
poetry config virtualenvs.in-project true # global; or: POETRY_VIRTUALENVS_IN_PROJECT=true
|
|
53
|
+
poetry env info --path
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## Running
|
|
57
|
+
|
|
58
|
+
```bash
|
|
59
|
+
poetry run robot --outputdir results tests
|
|
60
|
+
poetry run robotcode discover info
|
|
61
|
+
poetry run robocop --version
|
|
62
|
+
eval $(poetry env activate) # Poetry 2: activate in the current shell (`poetry shell` is now a plugin)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Reproducing and updating
|
|
66
|
+
|
|
67
|
+
Commit `pyproject.toml` and `poetry.lock`.
|
|
68
|
+
|
|
69
|
+
```bash
|
|
70
|
+
poetry install # exact versions from poetry.lock
|
|
71
|
+
poetry install --only main # without the dev group
|
|
72
|
+
poetry update robotframework-browser
|
|
73
|
+
poetry remove robotframework-seleniumlibrary
|
|
74
|
+
poetry check # validate pyproject.toml
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
If Poetry picks the wrong interpreter (for example a shim from pyenv or rye that fails), point it at a real Python: `poetry env use /path/to/python3.12`.
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
# Project Layout
|
|
2
|
+
|
|
3
|
+
```text
|
|
4
|
+
my-tests/
|
|
5
|
+
pyproject.toml # dependencies (uv / Poetry) – or requirements.txt (+ requirements.lock.txt)
|
|
6
|
+
uv.lock # or poetry.lock – commit it
|
|
7
|
+
.python-version # uv python pin 3.12 – commit it
|
|
8
|
+
robot.toml # shared robot options and profiles (read by robotcode)
|
|
9
|
+
.gitignore
|
|
10
|
+
tests/ # suites: *.robot, one folder per area
|
|
11
|
+
smoke.robot
|
|
12
|
+
api/
|
|
13
|
+
web/
|
|
14
|
+
resources/ # *.resource files with shared keywords
|
|
15
|
+
libraries/ # project Python keyword libraries (put on the python-path)
|
|
16
|
+
variables/ # variable files per environment (dev.yaml, staging.yaml)
|
|
17
|
+
results/ # output.xml, log.html, report.html, screenshots – gitignored
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
- Keep test data (`tests/`, `resources/`) apart from generated output (`results/`).
|
|
21
|
+
- How to write the tests, user keywords, `.resource` files and variable files in this tree: see `rf-language`.
|
|
22
|
+
- `libraries/` holds the project's Python keyword libraries. Put it on the python-path (`python-path` in `robot.toml`, `--pythonpath libraries` for plain `robot`) so suites import them as `Library MyLibrary`. Writing or fixing those libraries: rf-python-library.
|
|
23
|
+
|
|
24
|
+
## Variable files
|
|
25
|
+
|
|
26
|
+
- YAML variable files (`variables/dev.yaml`) need PyYAML in the project environment: `uv add pyyaml` (Poetry: `poetry add pyyaml`; requirements.txt: add `pyyaml`). Without it Robot Framework fails with "Using YAML variable files requires PyYAML module to be installed".
|
|
27
|
+
- JSON variable files (`variables/dev.json`) and Python variable files (`variables/common.py`) need no extra package.
|
|
28
|
+
- Select the environment per run. Plain `robot` does not read `robot.toml`, so pass the file on the command line:
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
uv run robot --outputdir results --pythonpath libraries --variablefile variables/staging.yaml tests
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
- With robotcode, keep the choice in a `robot.toml` profile and run `uv run robotcode -p staging robot`:
|
|
35
|
+
|
|
36
|
+
```toml
|
|
37
|
+
[profiles.staging]
|
|
38
|
+
variable-files = ["variables/staging.yaml"]
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
## robot.toml
|
|
42
|
+
|
|
43
|
+
`robot.toml` stores `robot` options once, so every run, IDE and robotcode command uses the same settings (see `assets/examples/robot.toml`):
|
|
44
|
+
|
|
45
|
+
```toml
|
|
46
|
+
output-dir = "results"
|
|
47
|
+
python-path = ["resources", "libraries"]
|
|
48
|
+
paths = ["tests"]
|
|
49
|
+
|
|
50
|
+
[variables]
|
|
51
|
+
HEADLESS = "true"
|
|
52
|
+
|
|
53
|
+
[profiles.headed]
|
|
54
|
+
variables = { HEADLESS = "false" }
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
- Plain `robot` does **not** read `robot.toml`; only robotcode does. Use `robotcode robot`, or pass the same options on the `robot` command line.
|
|
58
|
+
- Without robotcode: `uv run robot --outputdir results --pythonpath resources --pythonpath libraries tests`.
|
|
59
|
+
|
|
60
|
+
## .gitignore
|
|
61
|
+
|
|
62
|
+
Add the environment and outputs (full example: `assets/examples/gitignore.txt`):
|
|
63
|
+
|
|
64
|
+
```gitignore
|
|
65
|
+
.venv/
|
|
66
|
+
results/
|
|
67
|
+
output.xml
|
|
68
|
+
log.html
|
|
69
|
+
report.html
|
|
70
|
+
playwright-log.txt
|
|
71
|
+
browser/
|
|
72
|
+
.robotcode_cache/
|
|
73
|
+
__pycache__/
|
|
74
|
+
.pabotsuitenames
|
|
75
|
+
pabot_results/
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
Don't ignore `uv.lock`, `poetry.lock`, `.python-version` or `requirements*.txt`.
|
|
79
|
+
|
|
80
|
+
## Smoke test
|
|
81
|
+
|
|
82
|
+
Copy `assets/examples/smoke.robot` to `tests/smoke.robot`. It only uses standard libraries and prints the Robot Framework version and the interpreter path, so it proves that the right environment runs `robot`:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
uv run robot --outputdir results tests/smoke.robot
|
|
86
|
+
```
|