robotcode 2.5.0__py3-none-any.whl → 2.6.0__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.
robotcode/cli/__init__.py CHANGED
@@ -1,6 +1,7 @@
1
1
  import json
2
2
  import logging
3
3
  import logging.config
4
+ import os
4
5
  from pathlib import Path
5
6
  from typing import Any, List, Literal, Optional
6
7
 
@@ -14,6 +15,7 @@ from robotcode.plugin import (
14
15
  OutputFormat,
15
16
  pass_application,
16
17
  )
18
+ from robotcode.plugin._agent_detection import is_running_in_ai_agent
17
19
  from robotcode.plugin.click_helper.aliases import AliasedGroup
18
20
  from robotcode.plugin.click_helper.types import EnumChoice
19
21
  from robotcode.plugin.manager import PluginManager
@@ -105,14 +107,19 @@ class RobotCodeFormatter(logging.Formatter):
105
107
  "--color / --no-color",
106
108
  "color",
107
109
  default=None,
108
- help="Whether or not to display colored output (default is auto-detection).",
110
+ help=(
111
+ "Force or disable colored output. Default (no flag): auto-detect — colors only when stdout is a TTY,"
112
+ " disabled if `NO_COLOR` is set, forced if `FORCE_COLOR` is set."
113
+ ),
109
114
  show_envvar=True,
110
115
  )
111
116
  @click.option(
112
117
  "--pager / --no-pager",
113
118
  "pager",
114
- default=False,
115
- help="Whether or not use a pager to display long text or data.",
119
+ default=None,
120
+ help=(
121
+ "Force or disable the pager. Default (no flag): auto-page when the rendered output exceeds the terminal height."
122
+ ),
116
123
  show_envvar=True,
117
124
  )
118
125
  @click.option(
@@ -271,6 +278,16 @@ def robotcode(
271
278
  else:
272
279
  app.config.colored_output = ColoredOutput.NO
273
280
  app.config.pager = pager
281
+
282
+ # AI-agent auto-detect: when running inside a known agent session
283
+ # (Claude Code, Copilot, OpenCode, …) demote colour and pager
284
+ # defaults so the agent's stdout capture stays clean. Explicit CLI
285
+ # flags and `NO_COLOR` / `FORCE_COLOR` keep their precedence.
286
+ if is_running_in_ai_agent():
287
+ if color is None and not os.environ.get("NO_COLOR") and not os.environ.get("FORCE_COLOR"):
288
+ app.config.colored_output = ColoredOutput.NO
289
+ if pager is None:
290
+ app.config.pager = False
274
291
  app.config.output_format = format
275
292
  app.config.launcher_script = launcher_script
276
293
  app.config.default_paths = default_path
@@ -1 +1 @@
1
- __version__ = "2.5.0"
1
+ __version__ = "2.6.0"
@@ -0,0 +1,226 @@
1
+ Metadata-Version: 2.4
2
+ Name: robotcode
3
+ Version: 2.6.0
4
+ Summary: Command line interface for RobotCode
5
+ Project-URL: Homepage, https://robotcode.io
6
+ Project-URL: Donate, https://opencollective.com/robotcode
7
+ Project-URL: Documentation, https://github.com/robotcodedev/robotcode#readme
8
+ Project-URL: Changelog, https://github.com/robotcodedev/robotcode/blob/main/CHANGELOG.md
9
+ Project-URL: Issues, https://github.com/robotcodedev/robotcode/issues
10
+ Project-URL: Source, https://github.com/robotcodedev/robotcode
11
+ Author-email: Daniel Biehl <dbiehl@live.de>
12
+ License: Apache-2.0
13
+ License-File: LICENSE.txt
14
+ Keywords: Acceptance Test Driven Development,Acceptance Testing,BDD,BDT,Behavior Driven Testing,Data Driven,Debug Adapter Protocol,Keyword Driven,Language Server Protocol,RPA,RobotFramework,Robotic Process Automation,Test,Testing,Visual Studio Code
15
+ Classifier: Development Status :: 5 - Production/Stable
16
+ Classifier: Framework :: Robot Framework
17
+ Classifier: Framework :: Robot Framework :: Tool
18
+ Classifier: Intended Audience :: Developers
19
+ Classifier: License :: OSI Approved :: Apache Software License
20
+ Classifier: Operating System :: OS Independent
21
+ Classifier: Programming Language :: Python :: 3.10
22
+ Classifier: Programming Language :: Python :: 3.11
23
+ Classifier: Programming Language :: Python :: 3.12
24
+ Classifier: Programming Language :: Python :: 3.13
25
+ Classifier: Programming Language :: Python :: 3.14
26
+ Classifier: Programming Language :: Python :: Implementation :: CPython
27
+ Classifier: Topic :: Software Development :: Debuggers
28
+ Classifier: Topic :: Software Development :: Quality Assurance
29
+ Classifier: Topic :: Software Development :: Testing
30
+ Classifier: Topic :: Software Development :: Testing :: Acceptance
31
+ Classifier: Topic :: Software Development :: Testing :: BDD
32
+ Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
33
+ Classifier: Topic :: Utilities
34
+ Classifier: Typing :: Typed
35
+ Requires-Python: >=3.10
36
+ Requires-Dist: robotcode-core==2.6.0
37
+ Requires-Dist: robotcode-plugin==2.6.0
38
+ Requires-Dist: robotcode-robot==2.6.0
39
+ Provides-Extra: all
40
+ Requires-Dist: docutils; extra == 'all'
41
+ Requires-Dist: pyyaml>=5.4; extra == 'all'
42
+ Requires-Dist: robotcode-analyze==2.6.0; extra == 'all'
43
+ Requires-Dist: robotcode-debugger==2.6.0; extra == 'all'
44
+ Requires-Dist: robotcode-language-server==2.6.0; extra == 'all'
45
+ Requires-Dist: robotcode-repl-server==2.6.0; extra == 'all'
46
+ Requires-Dist: robotcode-repl==2.6.0; extra == 'all'
47
+ Requires-Dist: robotcode-runner[html]==2.6.0; extra == 'all'
48
+ Requires-Dist: robotframework-robocop>=6.0.0; extra == 'all'
49
+ Provides-Extra: analyze
50
+ Requires-Dist: robotcode-analyze==2.6.0; extra == 'analyze'
51
+ Provides-Extra: debugger
52
+ Requires-Dist: robotcode-debugger==2.6.0; extra == 'debugger'
53
+ Provides-Extra: languageserver
54
+ Requires-Dist: robotcode-language-server==2.6.0; extra == 'languageserver'
55
+ Provides-Extra: lint
56
+ Requires-Dist: robotframework-robocop>=2.0.0; extra == 'lint'
57
+ Provides-Extra: repl
58
+ Requires-Dist: robotcode-repl==2.6.0; extra == 'repl'
59
+ Provides-Extra: replserver
60
+ Requires-Dist: robotcode-repl-server==2.6.0; extra == 'replserver'
61
+ Provides-Extra: rest
62
+ Requires-Dist: docutils; extra == 'rest'
63
+ Provides-Extra: runner
64
+ Requires-Dist: robotcode-runner==2.6.0; extra == 'runner'
65
+ Provides-Extra: yaml
66
+ Requires-Dist: pyyaml>=5.4; extra == 'yaml'
67
+ Description-Content-Type: text/markdown
68
+
69
+ # RobotCode - The Ultimate Robot Framework Toolset
70
+
71
+ [![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/main/LICENSE)
72
+ [![Build Status](https://img.shields.io/github/actions/workflow/status/robotcodedev/robotcode/build-test-package-publish.yml?branch=main&style=flat&logo=github)](https://github.com/robotcodedev/robotcode/actions?query=workflow:build_test_package_publish)
73
+ [![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/d-biehl.robotcode?style=flat&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
74
+ [![Installs](https://img.shields.io/visual-studio-marketplace/i/d-biehl.robotcode?style=flat)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
75
+ [![JetBrains Marketplace](https://img.shields.io/jetbrains/plugin/v/26216.svg)](https://plugins.jetbrains.com/plugin/26216)
76
+ [![Downloads](https://img.shields.io/jetbrains/plugin/d/26216.svg)](https://plugins.jetbrains.com/plugin/26216)
77
+ [![PyPI - Version](https://img.shields.io/pypi/v/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
78
+ [![Python Version](https://img.shields.io/pypi/pyversions/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
79
+ [![Downloads](https://img.shields.io/pypi/dm/robotcode.svg?style=flat&label=downloads)](https://pypi.org/project/robotcode)
80
+
81
+ ---
82
+
83
+ ## What is RobotCode?
84
+
85
+ RobotCode is a complete Robot Framework toolkit: a language server, IDE extensions for VS Code and the JetBrains platform, a powerful command-line interface, and a unified `robot.toml`-based configuration model. It is designed for everyday Robot Framework work — from your first keyword to scaling multi-team test suites in CI.
86
+
87
+ Built on Robot Framework Core, RobotCode is developed in close collaboration with the Robot Framework Core team and supported by the [Robot Framework Foundation](https://robotframework.org/foundation/).
88
+
89
+
90
+ ## Key Features
91
+
92
+ ### Editor / IDE
93
+
94
+ - **Code intelligence** — completion for keywords, variables, libraries, and resources; hover documentation; go-to-definition; find references; signature help.
95
+ - **Keywords explorer** — browse, navigate, and insert keywords from imported libraries and resources via a dedicated sidebar view.
96
+ - **Refactoring** — project-wide rename of keywords, variables, and arguments.
97
+ - **Live diagnostics** — errors and warnings as you type, out of the box. Optional [Robocop](https://robocop.readthedocs.io/) integration adds further linting and formatting checks on top.
98
+ - **Debugging** — Robot Framework debugging via the [Debug Adapter Protocol](https://microsoft.github.io/debug-adapter-protocol/), with breakpoints in keywords and step-through control.
99
+ - **Syntax highlighting** — full Robot Framework grammar including embedded arguments, Python expressions, and environment variables with defaults.
100
+ - **Snippets** — quick insertion of common Robot Framework patterns.
101
+ - **Test view** — discover, run, debug, and inspect Robot Framework tests in the editor's test panel.
102
+ - **Interactive REPL & `.robotbook` notebooks** — try keywords live in a REPL or work in a Jupyter Notebook-style notebook format.
103
+ - **Multi-root workspaces** — manage multiple projects with different Python environments side by side.
104
+
105
+ ### Configuration
106
+
107
+ One configuration model that follows your project from the editor into CI — no scattered command-line flags, no duplicated setups.
108
+
109
+ - **A single source of truth** — paths, variables, Python paths, listeners, modifiers, and every Robot Framework option live in `robot.toml` (or `pyproject.toml`). Editor, CLI, and CI all read the same setup; personal tweaks stay out of git via `.robot.toml`.
110
+ - **Profiles for every scenario** — keep dev, staging, CI, OS-specific, or browser-specific settings as named overlays. Activate with a single flag, layer them, inherit between them.
111
+ - **Total transparency** — see exactly what Robot Framework will receive after all files, profile overlays, and CLI flags are merged.
112
+ - **Schema-guided editing** — autocomplete and validation while you write your config catches typos and unsupported keys before you run.
113
+
114
+ ### Command line
115
+
116
+ A complete command-line toolkit that knows your project as well as the editor does — same `robot.toml`, same profiles, same Python environment — so what runs in the IDE runs the same way on the CLI and in CI.
117
+
118
+ - **Run with everything wired up** — execute Robot Framework with your profiles, paths, variables, listeners, and modifiers automatically applied.
119
+ - **Find tests by anything** — search and filter suites, tasks, tags, sources, documentation, or even keyword calls inside test bodies, and narrow the run accordingly.
120
+ - **Drill into failures fast** — explore logs, stats, and diffs across runs, and compare today's run against yesterday's in a single command — without ever parsing `output.xml` by hand.
121
+ - **CI gates with editor-quality diagnostics** — project-wide static analysis that matches what you see while typing; reclassify, mask, or ignore categories per project.
122
+ - **Docs that actually find your project** — library and keyword documentation that resolves your project's resources, custom libraries, and Python paths the way Robot itself does.
123
+ - **Live experimentation** — try keywords interactively inside your project's environment before they land in a test.
124
+ - **Built for automation** — every command can speak JSON, so CI pipelines, dashboards, AI agents, and other tools consume the output without screen-scraping.
125
+
126
+ For the complete feature reference, see the [official documentation](https://robotcode.io).
127
+
128
+ ## Requirements
129
+
130
+ **Runtime (always required):**
131
+ - Python 3.10 or newer
132
+ - Robot Framework 5.0 or newer
133
+
134
+ **Editor / IDE — any LSP-capable editor works.** For the dedicated extensions you need one of:
135
+ - Visual Studio Code 1.108.0 or newer
136
+ - PyCharm / IntelliJ IDEA 2025.3 or newer
137
+
138
+ Other editors (Neovim, Sublime Text, Helix, Emacs, …) connect to the language server via the `languageserver` extra from PyPI — see [Command Line and Other Editors](#command-line-and-other-editors) below.
139
+
140
+
141
+ ## Getting Started
142
+
143
+ ### Visual Studio Code
144
+
145
+ 1. **Install the RobotCode Extension** from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode).
146
+ 2. **Continue with the [Getting Started Guide](https://robotcode.io/02_get_started/)** for setup, your first `robot.toml`, and running your first test.
147
+
148
+ **Extensions:**
149
+ RobotCode declares dependencies on the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and [Python Debugger](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy) extensions so VS Code installs them when required. Additional extensions may be needed depending on your project.
150
+
151
+
152
+ ### IntelliJ IDEA or PyCharm
153
+
154
+ 1. **Install the RobotCode Plugin** — choose one of:
155
+
156
+ - **Built-in Plugin Marketplace:** <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > search for "RobotCode" > <kbd>Install</kbd>.
157
+ - **[JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26216):** click <kbd>Install to ...</kbd> if your IDE is running.
158
+ - **Manual:** download the [latest release](https://github.com/robotcodedev/robotcode/releases/latest) and use <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>.
159
+
160
+ 2. **Continue with the [Getting Started Guide](https://robotcode.io/02_get_started/)** for setup, your first `robot.toml`, and running your first test.
161
+
162
+ **Plugins:**
163
+ RobotCode declares a dependency on [LSP4IJ](https://plugins.jetbrains.com/plugin/23257) so your IDE installs it automatically. Additional plugins may be required depending on your project needs.
164
+
165
+
166
+ ### Command Line and Other Editors
167
+
168
+ For CI pipelines, the command line, or LSP-compatible editors like Neovim, Sublime Text, or Helix, install RobotCode from PyPI. The base `robotcode` package is only the CLI core; the actual commands live in extras such as `runner`, `analyze`, `debugger`, `languageserver`, and `repl`:
169
+
170
+ ```bash
171
+ pip install robotcode[runner,analyze]
172
+ ```
173
+
174
+ Pick the extras that match your use case — see the [CLI reference](https://robotcode.io/03_reference/cli) for the available packages and how to install them.
175
+
176
+
177
+ ## Documentation
178
+
179
+ For detailed instructions, visit our **[official documentation](https://robotcode.io)**. Additional resources:
180
+
181
+ - **[Q&A](https://github.com/robotcodedev/robotcode/discussions/categories/q-a):** Answers to common questions about RobotCode.
182
+ - **[Tips & Tricks](https://robotcode.io/04_tip_and_tricks/):** Common pitfalls, editor customization, and setup recipes.
183
+ - **[Command Line Tools Reference](https://robotcode.io/03_reference/cli):** Comprehensive documentation on using RobotCode's CLI tools.
184
+ - **[Changelog](https://github.com/robotcodedev/robotcode/blob/main/CHANGELOG.md):** Track changes, updates, and new features in each release.
185
+ - **[Support & Contribute](https://robotcode.io/05_contributing/):** Ways to back the project — financial, code, feedback.
186
+
187
+
188
+ ## Sponsor RobotCode
189
+
190
+ RobotCode is driven by the passion of its lead developer and a growing community. Financial support keeps the project sustainable and lets us continue adding features, improving stability, and expanding the ecosystem.
191
+
192
+ **Individual:**
193
+ - [GitHub Sponsors](https://github.com/sponsors/robotcodedev) – monthly or one-time
194
+ - [Open Collective](https://opencollective.com/robotcode) – one-time or recurring
195
+
196
+ **Corporate:**
197
+ - [Open Collective](https://opencollective.com/robotcode) – direct, transparent, invoices, public ledger
198
+ - [Robot Framework Foundation membership](https://robotframework.org/foundation/) – ecosystem support, indirectly benefits RobotCode
199
+
200
+
201
+ ## Get Involved
202
+
203
+ You don't need to sponsor to help. Every contribution — feedback, code, advocacy — moves the project forward.
204
+
205
+ - Star the repository
206
+ - Leave a review on the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode) and [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26216)
207
+ - Ask questions & help others on [Slack #robotcode](https://slack.robotframework.org/), the [Forum](https://forum.robotframework.org), or [Discussions](https://github.com/robotcodedev/robotcode/discussions)
208
+ - Report bugs in the [issue tracker](https://github.com/robotcodedev/robotcode/issues)
209
+ - Suggest enhancements or features (issues or [Discussions](https://github.com/robotcodedev/robotcode/discussions))
210
+ - Share usage patterns & integration ideas in [Discussions](https://github.com/robotcodedev/robotcode/discussions)
211
+ - Improve tests (edge cases, large suites, multi-root, versions)
212
+ - Contribute code ([good first issue](https://github.com/robotcodedev/robotcode/labels/good%20first%20issue) / [help wanted](https://github.com/robotcodedev/robotcode/labels/help%20wanted))
213
+
214
+
215
+ ## License
216
+
217
+ This project is licensed under the [Apache 2.0 License](https://spdx.org/licenses/Apache-2.0.html).
218
+
219
+ ---
220
+
221
+ ## Powered by
222
+
223
+ [Robot Framework Foundation](https://robotframework.org/foundation)
224
+
225
+
226
+ [JetBrains](https://jb.gg/OpenSourceSupport)
@@ -0,0 +1,12 @@
1
+ robotcode/cli/__init__.py,sha256=-zPNouLiGkJg8KKz6gVzyVm47dXHqM-zv2gJV3r-n7Y,10254
2
+ robotcode/cli/__main__.py,sha256=hX3nwROMTnsYGT1KS0rXUYrslu9sFzctYdAh66Rcckw,153
3
+ robotcode/cli/__version__.py,sha256=OEib63e0yPEGlhEXyrWE1OwRnleR0cHI7KSX7oZEQLs,22
4
+ robotcode/cli/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
5
+ robotcode/cli/commands/__init__.py,sha256=XJHRt_YwMO2Ni2EfL2aj4jkJXMVG6NGFTpzvSVgIRnQ,92
6
+ robotcode/cli/commands/config.py,sha256=0Jmf7HDIo7IIaOMU9M_bYi7PdHAfcae6x3SW93NA3EA,10481
7
+ robotcode/cli/commands/profiles.py,sha256=5H9lvSVCMggWXf0IH54QtgDgqupEEvpcUrEsTZvZsNM,6127
8
+ robotcode-2.6.0.dist-info/METADATA,sha256=ydwqLWZ4glqXP4B-Krk7g1rHSsYfKXDZYfXN1XVOiJg,14588
9
+ robotcode-2.6.0.dist-info/WHEEL,sha256=mffPy8wBnZQn2VnJUU5jE99KsxaSfiyMHV9Yt0aLVxs,87
10
+ robotcode-2.6.0.dist-info/entry_points.txt,sha256=Pb4DKVVdJb5PboVl48njwk3DkKQHBJOL1A8KkpemqA8,58
11
+ robotcode-2.6.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
12
+ robotcode-2.6.0.dist-info/RECORD,,
@@ -1,4 +1,4 @@
1
1
  Wheel-Version: 1.0
2
- Generator: hatchling 1.29.0
2
+ Generator: hatchling 1.30.1
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
@@ -1,253 +0,0 @@
1
- Metadata-Version: 2.4
2
- Name: robotcode
3
- Version: 2.5.0
4
- Summary: Command line interface for RobotCode
5
- Project-URL: Homepage, https://robotcode.io
6
- Project-URL: Donate, https://opencollective.com/robotcode
7
- Project-URL: Documentation, https://github.com/robotcodedev/robotcode#readme
8
- Project-URL: Changelog, https://github.com/robotcodedev/robotcode/blob/main/CHANGELOG.md
9
- Project-URL: Issues, https://github.com/robotcodedev/robotcode/issues
10
- Project-URL: Source, https://github.com/robotcodedev/robotcode
11
- Author-email: Daniel Biehl <dbiehl@live.de>
12
- License: Apache-2.0
13
- License-File: LICENSE.txt
14
- Keywords: Acceptance Test Driven Development,Acceptance Testing,BDD,BDT,Behavior Driven Testing,Data Driven,Debug Adapter Protocol,Keyword Driven,Language Server Protocol,RPA,RobotFramework,Robotic Process Automation,Test,Testing,Visual Studio Code
15
- Classifier: Development Status :: 5 - Production/Stable
16
- Classifier: Framework :: Robot Framework
17
- Classifier: Framework :: Robot Framework :: Tool
18
- Classifier: Intended Audience :: Developers
19
- Classifier: License :: OSI Approved :: Apache Software License
20
- Classifier: Operating System :: OS Independent
21
- Classifier: Programming Language :: Python :: 3.10
22
- Classifier: Programming Language :: Python :: 3.11
23
- Classifier: Programming Language :: Python :: 3.12
24
- Classifier: Programming Language :: Python :: 3.13
25
- Classifier: Programming Language :: Python :: 3.14
26
- Classifier: Programming Language :: Python :: Implementation :: CPython
27
- Classifier: Topic :: Software Development :: Debuggers
28
- Classifier: Topic :: Software Development :: Quality Assurance
29
- Classifier: Topic :: Software Development :: Testing
30
- Classifier: Topic :: Software Development :: Testing :: Acceptance
31
- Classifier: Topic :: Software Development :: Testing :: BDD
32
- Classifier: Topic :: Text Editors :: Integrated Development Environments (IDE)
33
- Classifier: Topic :: Utilities
34
- Classifier: Typing :: Typed
35
- Requires-Python: >=3.10
36
- Requires-Dist: robotcode-core
37
- Requires-Dist: robotcode-plugin
38
- Requires-Dist: robotcode-robot
39
- Provides-Extra: all
40
- Requires-Dist: docutils; extra == 'all'
41
- Requires-Dist: pyyaml>=5.4; extra == 'all'
42
- Requires-Dist: rich; extra == 'all'
43
- Requires-Dist: robotcode-analyze; extra == 'all'
44
- Requires-Dist: robotcode-debugger; extra == 'all'
45
- Requires-Dist: robotcode-language-server; extra == 'all'
46
- Requires-Dist: robotcode-repl; extra == 'all'
47
- Requires-Dist: robotcode-repl-server; extra == 'all'
48
- Requires-Dist: robotcode-runner; extra == 'all'
49
- Requires-Dist: robotframework-robocop>=6.0.0; extra == 'all'
50
- Provides-Extra: analyze
51
- Requires-Dist: robotcode-analyze==2.5.0; extra == 'analyze'
52
- Provides-Extra: colored
53
- Requires-Dist: rich; extra == 'colored'
54
- Provides-Extra: debugger
55
- Requires-Dist: robotcode-debugger==2.5.0; extra == 'debugger'
56
- Provides-Extra: languageserver
57
- Requires-Dist: robotcode-language-server==2.5.0; extra == 'languageserver'
58
- Provides-Extra: lint
59
- Requires-Dist: robotframework-robocop>=2.0.0; extra == 'lint'
60
- Provides-Extra: repl
61
- Requires-Dist: robotcode-repl==2.5.0; extra == 'repl'
62
- Provides-Extra: replserver
63
- Requires-Dist: robotcode-repl-server==2.5.0; extra == 'replserver'
64
- Provides-Extra: rest
65
- Requires-Dist: docutils; extra == 'rest'
66
- Provides-Extra: runner
67
- Requires-Dist: robotcode-runner==2.5.0; extra == 'runner'
68
- Provides-Extra: yaml
69
- Requires-Dist: pyyaml>=5.4; extra == 'yaml'
70
- Description-Content-Type: text/markdown
71
-
72
- # RobotCode - The Ultimate Robot Framework Toolset
73
-
74
- [![License](https://img.shields.io/github/license/robotcodedev/robotcode?style=flat&logo=apache)](https://github.com/robotcodedev/robotcode/blob/main/LICENSE)
75
- [![Build Status](https://img.shields.io/github/actions/workflow/status/robotcodedev/robotcode/build-test-package-publish.yml?branch=main&style=flat&logo=github)](https://github.com/robotcodedev/robotcode/actions?query=workflow:build_test_package_publish)
76
- [![VS Code Marketplace](https://img.shields.io/visual-studio-marketplace/v/d-biehl.robotcode?style=flat&label=VS%20Marketplace&logo=visual-studio-code)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
77
- [![Installs](https://img.shields.io/visual-studio-marketplace/i/d-biehl.robotcode?style=flat)](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode)
78
- [![JetBrains Marketplace](https://img.shields.io/jetbrains/plugin/v/26216.svg)](https://plugins.jetbrains.com/plugin/26216)
79
- [![Downloads](https://img.shields.io/jetbrains/plugin/d/26216.svg)](https://plugins.jetbrains.com/plugin/26216)
80
- [![PyPI - Version](https://img.shields.io/pypi/v/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
81
- [![Python Version](https://img.shields.io/pypi/pyversions/robotcode.svg?style=flat)](https://pypi.org/project/robotcode)
82
- [![Downloads](https://img.shields.io/pypi/dm/robotcode.svg?style=flat&label=downloads)](https://pypi.org/project/robotcode)
83
-
84
- ---
85
-
86
- ## What is RobotCode?
87
-
88
- RobotCode is a comprehensive toolkit for Robot Framework development, offering advanced features to enhance your productivity and streamline your workflow. Whether you're using Visual Studio Code, IntelliJ, or other LSP-compatible editors, RobotCode ensures a consistent and seamless experience.
89
-
90
- ### Key Advantages:
91
-
92
- - **Built on Robot Framework Core**
93
- RobotCode uses Robot Framework's native parser for syntax validation, error messages, and behavior, ensuring full compatibility and reliability in your projects.
94
-
95
- - **Powered by the Language Server Protocol (LSP)**
96
- By leveraging the LSP, RobotCode provides real-time code navigation, intelligent auto-completion, and refactoring capabilities across various editors and IDEs.
97
-
98
- - **Multi-Platform IDE Extensions**
99
- RobotCode offers robust extensions for Visual Studio Code and IntelliJ Platform, delivering the same high-quality features regardless of your preferred development environment. Thanks to LSP, it also works with editors like Neovim and Sublime Text.
100
-
101
- - **Enhanced CLI Tools**
102
- Extend Robot Framework's command-line capabilities with tools for test execution, debugging, and code analysis. Features include `robot.toml` support, a Debug Adapter Protocol (DAP) debugger, and an interactive REPL for quick experimentation.
103
-
104
- With RobotCode, you can focus on building and testing your automation workflows while enjoying an integrated and efficient development experience.
105
-
106
-
107
- ## Key Features
108
-
109
- - **Code Editing**: Enjoy code auto-completion, navigation and more.
110
- - **IntelliSense**: Get code completion suggestions for keywords, variables, and more.
111
- - **Refactoring**: Rename variables, keywords, arguments and more with ease and project wide.
112
- - **Enhanced Syntax Highlighting**: Easily identify and read your Robot Framework code with support highlight embedded arguments, python expressions, environment variables with default values, and more.
113
- - **Code Snippets**: Quickly insert common Robot Framework code snippets.
114
- - **Test Discovery**: Discover and run Robot Framework test cases directly within VS Code.
115
- - **Test Execution**: Execute Robot Framework test cases and suites directly within VS Code.
116
- - **Test Reports**: View test reports directly within VS Code.
117
- - **Debugging**: Debug your Robot Framework tests with ease.
118
- - **Command Line Tools**: A wide array of tools to assist in setting up and managing Robot Framework environments.
119
- - **Code Analysis with Robocop**: Install [Robocop](https://robocop.readthedocs.io/) for additional code analysis.
120
- - **Code Formatting**: Use [Robocop's formatter](https://robocop.readthedocs.io/) for consistent code formatting.
121
- - **Multi-root Workspace Support**: Manage multiple Robot Framework projects with different Python environments simultaneously.
122
- - **Customizable Settings**: Configure the extension to fit your needs.
123
- - **RobotCode Repl and Notebooks**: Play with Robot Framework in a Jupyter Notebook-like environment.
124
- - **And More!**: Check out the [official documentation](https://robotcode.io) for more details.
125
-
126
- ## Requirements
127
-
128
- ### Python and Robot Framework Versions
129
- - Python 3.10 or newer
130
- - Robot Framework 5.0 or newer
131
-
132
- ### IDE Support
133
-
134
- - Visual Studio Code 1.99.0 or newer
135
- - PyCharm 2025.1 or newer or IntelliJ IDEA 2025.1 or newer
136
-
137
- ### Python and Robot Framework Version Requirements
138
-
139
- **Python Version Requirements:**
140
- RobotCode requires Python 3.10 or newer. Python 3.8 and 3.9 are no longer supported as they have reached or are approaching end-of-life status. Python 3.10 provides several important improvements that enable cleaner, more efficient code:
141
- • Structural pattern matching
142
- • More informative error messages
143
- • Simplified type hints using the | operator
144
- • Performance enhancements
145
-
146
- **Robot Framework Version Requirements:**
147
- RobotCode supports Robot Framework 5.0 or later. Older versions like Robot Framework 4.1 are no longer supported due to their outdated nature and the regular release cadence of Robot Framework.
148
-
149
- **Why These Requirements:**
150
- Many key tools in the Robot Framework ecosystem—such as robocop and the Browser library—have already moved to similar requirements. This alignment ensures compatibility and allows RobotCode to leverage modern Python features for improved performance and developer experience.
151
-
152
- **Recommendation:**
153
- To get the most out of RobotCode, we recommend using:
154
- • Python 3.10 or newer
155
- • Robot Framework 5.0 or newer
156
-
157
-
158
- ## Getting Started
159
-
160
- ### Visual Studio Code
161
-
162
- 1. **Install the RobotCode Extension**
163
- Open the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode) and install the RobotCode extension.
164
-
165
- 2. **Set Up Your Environment**
166
- Configure your Robot Framework environment using the tools and commands provided by the extension or the `robot.toml` file.
167
-
168
- 3. **Start Testing**
169
- Begin writing and running your Robot Framework tests directly in VS Code.
170
-
171
- 4. **Explore More**
172
- Visit the [Getting Started Guide](https://robotcode.io/02_get_started/) for detailed setup instructions and advanced features.
173
-
174
- **Extensions:**
175
- RobotCode declares dependencies on the [Python](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and [Python Debugger](https://marketplace.visualstudio.com/items?itemName=ms-python.debugpy) extensions so VS Code installs them when required. Additional extensions may be needed depending on your project.
176
-
177
-
178
- ### IntelliJ IDEA or PyCharm
179
-
180
- 1. **Install the RobotCode Plugin**
181
- Choose one of the following methods to install the RobotCode plugin in your IDE:
182
-
183
- - **Install via the Built-in Plugin Marketplace**
184
- Navigate to:
185
- <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>Marketplace</kbd> > Search for "RobotCode" and click <kbd>Install</kbd>.
186
-
187
- - **Use the JetBrains Marketplace**
188
- Alternatively, install the plugin directly from the [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26216). Click the <kbd>Install to ...</kbd> button if your IDE is running.
189
-
190
- - **Manual Installation**
191
- Download the [latest release](https://github.com/robotcodedev/robotcode/releases/latest) and install it manually:
192
- <kbd>Settings/Preferences</kbd> > <kbd>Plugins</kbd> > <kbd>⚙️</kbd> > <kbd>Install plugin from disk...</kbd>.
193
-
194
- 2. **Set Up Your Environment**
195
- Configure your Robot Framework environment using the tools and commands provided by the plugin or the `robot.toml` file.
196
-
197
- 3. **Start Testing**
198
- Begin developing and executing your Robot Framework tests.
199
-
200
- 4. **Explore More**
201
- Visit the [Getting Started Guide](https://robotcode.io/02_get_started/) for detailed setup instructions and advanced features.
202
-
203
- **Plugins:**
204
- RobotCode declares a dependency on [LSP4IJ](https://plugins.jetbrains.com/plugin/23257) so your IDE installs it automatically. Additional plugins may be required depending on your project needs.
205
-
206
-
207
- ## Documentation
208
-
209
- For detailed instructions, visit our **[official documentation](https://robotcode.io)**.
210
- Here are some additional resources to help you troubleshoot or learn more:
211
-
212
- - **[Q&A](https://github.com/robotcodedev/robotcode/discussions/categories/q-a):** Answers to common questions about RobotCode.
213
- - **[Troubleshooting Guide](https://robotcode.io/04_tip_and_tricks/troubleshooting):** Solutions for setup issues, performance problems, and debugging errors.
214
- - **[Command Line Tools Reference](https://robotcode.io/03_reference/):** Comprehensive documentation on using RobotCode’s CLI tools.
215
- - **[Changelog](https://github.com/robotcodedev/robotcode/blob/main/CHANGELOG.md):** Track changes, updates, and new features in each release.
216
- - **[Support](https://robotcode.io/support/):** Learn how to get help and report issues.
217
-
218
-
219
- ## Support RobotCode
220
-
221
- RobotCode is driven by the passion of its lead developer and the support of a growing community. To continue adding new features, improving stability, and expanding the ecosystem, your involvement is essential. Whether you contribute code, offer feedback, or provide financial support, you help shape the future of RobotCode.
222
-
223
- **Become a Sponsor:**
224
- - [GitHub Sponsors](https://github.com/sponsors/robotcodedev) - Monthly or one-time sponsorship
225
- - [Open Collective](https://opencollective.com/robotcode) - One-time or recurring donations
226
-
227
- **Corporate Sponsorship:**
228
- - Direct & transparent: Open Collective (https://opencollective.com/robotcode) – invoices, public ledger
229
- - Ecosystem support: Robot Framework Foundation membership (https://robotframework.org/foundation/) – indirectly benefits RobotCode
230
-
231
- **Other Ways to Support:**
232
- - Star the repository
233
- - Leave a review on the [VS Code Marketplace](https://marketplace.visualstudio.com/items?itemName=d-biehl.robotcode) and [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/26216)
234
- - Ask questions & help others ([Slack #robotcode](https://slack.robotframework.org/) / [Forum](https://forum.robotframework.org) / [Discussions](https://github.com/robotcodedev/robotcode/discussions))
235
- - Report bugs in the [issue tracker](https://github.com/robotcodedev/robotcode/issues)
236
- - Suggest enhancements or features (issues or [Discussions](https://github.com/robotcodedev/robotcode/discussions))
237
- - Share usage patterns & integration ideas ([Discussions](https://github.com/robotcodedev/robotcode/discussions))
238
- - Improve tests (edge cases, large suites, multi-root, versions)
239
- - Contribute code ([good first issue](https://github.com/robotcodedev/robotcode/labels/good%20first%20issue) / [help wanted](https://github.com/robotcodedev/robotcode/labels/help%20wanted))
240
-
241
-
242
- ## License
243
-
244
- This project is licensed under the [Apache 2.0 License](https://spdx.org/licenses/Apache-2.0.html).
245
-
246
- ---
247
-
248
- ## Powered by
249
-
250
- [Robot Framework Foundation](https://robotframework.org/foundation)
251
-
252
-
253
- [JetBrains](https://jb.gg/OpenSourceSupport)
@@ -1,12 +0,0 @@
1
- robotcode/cli/__init__.py,sha256=dQ0Hhc3BJCf07zyHINEfAYROccgsnP-jcRUYzdTmD9g,9456
2
- robotcode/cli/__main__.py,sha256=hX3nwROMTnsYGT1KS0rXUYrslu9sFzctYdAh66Rcckw,153
3
- robotcode/cli/__version__.py,sha256=fMbNgIJqxiZEaSBLadLBt4rZpCHqarzb4Okt-aWsp2E,22
4
- robotcode/cli/py.typed,sha256=bWew9mHgMy8LqMu7RuqQXFXLBxh2CRx0dUbSx-3wE48,27
5
- robotcode/cli/commands/__init__.py,sha256=XJHRt_YwMO2Ni2EfL2aj4jkJXMVG6NGFTpzvSVgIRnQ,92
6
- robotcode/cli/commands/config.py,sha256=0Jmf7HDIo7IIaOMU9M_bYi7PdHAfcae6x3SW93NA3EA,10481
7
- robotcode/cli/commands/profiles.py,sha256=5H9lvSVCMggWXf0IH54QtgDgqupEEvpcUrEsTZvZsNM,6127
8
- robotcode-2.5.0.dist-info/METADATA,sha256=4pgsTOz3ujvZZay_3IF9KEx_6MwI59a1waVIjMd3b6k,14643
9
- robotcode-2.5.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
10
- robotcode-2.5.0.dist-info/entry_points.txt,sha256=Pb4DKVVdJb5PboVl48njwk3DkKQHBJOL1A8KkpemqA8,58
11
- robotcode-2.5.0.dist-info/licenses/LICENSE.txt,sha256=B05uMshqTA74s-0ltyHKI6yoPfJ3zYgQbvcXfDVGFf8,10280
12
- robotcode-2.5.0.dist-info/RECORD,,