{"id":47615431,"url":"https://github.com/viadee/robotframework-roboview","last_synced_at":"2026-04-01T21:20:28.975Z","repository":{"id":337403790,"uuid":"1149692721","full_name":"viadee/robotframework-roboview","owner":"viadee","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-02T14:44:48.000Z","size":8990,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-03-02T17:48:19.462Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/viadee.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-02-04T12:09:41.000Z","updated_at":"2026-03-02T14:43:28.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/viadee/robotframework-roboview","commit_stats":null,"previous_names":["viadee/robotframework-roboview"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/viadee/robotframework-roboview","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Frobotframework-roboview","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Frobotframework-roboview/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Frobotframework-roboview/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Frobotframework-roboview/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/viadee","download_url":"https://codeload.github.com/viadee/robotframework-roboview/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/viadee%2Frobotframework-roboview/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31292158,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-01T21:15:39.731Z","status":"ssl_error","status_checked_at":"2026-04-01T21:15:34.046Z","response_time":53,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-01T21:20:28.319Z","updated_at":"2026-04-01T21:20:28.965Z","avatar_url":"https://github.com/viadee.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RoboView - Keyword Management in Robot Framework\n![banner](./static/github_banner.png)\n[![PyPI version](https://img.shields.io/pypi/v/robotframework-roboview.svg)](https://pypi.org/project/robotframework-roboview/)\n![license](https://img.shields.io/badge/license-Apache--2.0-green)\n![python](https://img.shields.io/badge/python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14-blue)\n\n\nRoboView is a Visual Studio Code extension designed to help you manage keywords within your Robot Framework projects and improve overall test quality through built-in Robocop integration. Its primary goal is to provide a comprehensive overview of all keywords and their relationships, making it easier to understand and maintain your test automation codebase.\n\n---\n\n\u003ch2 style=\"border-bottom: none; margin-bottom: 1em;\"\u003e✨ Key Features\u003c/h2\u003e\n\n- 🗂️ **Workspace:** Automatically selects your current workspace project and generates comprehensive overviews.\n- 📈 **Dashboard:** Get key performance indicators and a general overview of your robot framework project.\n- 📝 **Keyword Overview \u0026 Filtering:** Instantly view all keywords of a selected file, filter by type (initialized, called).\n- ❓ **Global Filter:** Searches your files for any keywords lacking documentation, unused keywords or faulty keywords with cycle calling.\n- 📖 **Detailed Keyword Insights:** Select any keyword to see where it is defined, how often it is used (both in its own file and across the project), and view its documentation.\n- 🧩 **Similarity Detection:** Get information about similar or potentially duplicate keywords through similarity analysis of keyword source code.\n- 🧭 **Code Navigation:** Jump straight to a keyword’s definition with a simple Ctrl+Click.\n- 🛡️ **Robocop Integration:** Runs Robocop directly from within RoboView, inspect lint results in context, and use your custom configuration file (e.g. robocop.toml) out of the box.\n- 🔍 **Search \u0026 Sorting:** Quickly find keywords using the search bar and sort them by name or usage statistics.\n\n---\n\n\u003ch2 style=\"border-bottom: none; margin-bottom: 1em;\"\u003e⚙️ Installation Guide\u003c/h2\u003e\n\nRoboView consists of two parts: a **backend** (Python package) and a **frontend** (Visual Studio Code extension).\n\n### ✅ Backend\n\nInstall the backend via **pip**:\n\n```bash\npip install robotframework-roboview\n```\n\n### ✅ Frontend\n\nThe Frontend is available as a Visual Studio Code extension on the Marketplace – install it in seconds from the VS Code Extensions view.\n1. Open **Visual Studio Code**.\n2. Go to the **Extensions** view (`Ctrl+Shift+X` / `Cmd+Shift+X`).\n3. Search for **\"RoboView\"**.\n4. Install the RoboView extension by *viadee Unternehmensberatung AG*.\n\n---\n\n\u003ch2 style=\"border-bottom: none; margin-bottom: 1em;\"\u003e🛠️ GitHub\u003c/h2\u003e\n\nYou can find the RoboView source code and issue tracker on GitHub:\n\n👉 **https://github.com/viadee/robotframework-roboview**\n\n---\n\n\u003ch2 style=\"border-bottom: none; margin-bottom: 1em;\"\u003e📝 Notes and Recommendations\u003c/h2\u003e\n\n- For Robocop to automatically detect your configuration, name the file **`robocop.toml`**, **`robot.toml`** or integrate in **`pyproject.toml`**.  \n  If you cannot change the filename in your project, you can instead set the environment variable **`ROBOCOP_CONFIG_PATH`** to the full path of your config file.\n- If the Robocop configuration file is outdated or cannot be parsed, RoboView falls back to **Robocop’s default settings**. The same applies if no configuration file is found.\n- RoboView follows your IDE’s color theme. We recommend using a **dark theme**, as text in light themes can be harder to read - but feel free to experiment and choose what works best for you.\n\n---\n\n\u003ch2 style=\"border-bottom: none; margin-bottom: 1em;\"\u003e🔍 How to navigate RoboView\u003c/h2\u003e\n\nIn the following three sections, we will dive deeper into how to navigate RoboView: where to find the features and understand the terminology we use. We start with the dashboard, then look at the keyword usage overview, and finally the Robocop integration.\nYou can switch between these views using the buttons in the top-right corner of RoboView: \u003ccode\u003eDashboard\u003c/code\u003e, \u003ccode\u003eKeyword Usage\u003c/code\u003e, and \u003ccode\u003eRobocop\u003c/code\u003e.\n\n\u003ch3 style=\"border-bottom: none; margin-bottom: 1em;\"\u003e📋 1) Dashboard\u003c/h3\u003e\n\nThe **Dashboard** gives you a high‑level overview of the selected Robot Framework project and its overall health.\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./static/dashboard_1.png\" alt=\"keyword_list\" width=\"900\"/\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./static/dashboard_2.png\" alt=\"keyword_list\" width=\"900\"/\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\nAt the top of the dashboard you’ll see the **Selected Project**. RoboView automatically detects your current workspace and shows:\n- The **project name**\n- The **absolute path** to the project root\n\nThis ensures all metrics are calculated against the correct `.robot` and `.resource` files.\n\n### KPIs\n\nThe **KPIs** section summarizes the most important metrics of your test suite:\n- **User Defined Keywords**: Total number of custom keywords found in your project.\n- **Keyword Reuse Rate**: Percentage of keywords that are used more than once. A higher value indicates better reuse and less duplication/redundancy.\n- **Unused Keywords**: Number of keywords that are never called anywhere in the project. Use this to identify dead code and candidates for cleanup.\n- **Robocop Issues**: Total number of Robocop violations detected across the project. This helps you quickly assess structural and style problems in your tests.\n- **Documentation Coverage**: Percentage of keywords that contain a `[Documentation]` section. A higher value means your test suite is better documented and easier to maintain.\n- **Robot Framework Files**: Total number of `.robot` and `.resource` files that were analyzed. Use the dashboard to quickly spot problematic areas (e.g. many unused keywords, low documentation coverage, or a high number of Robocop issues) and decide where to focus your refactoring or cleanup efforts first.\n\n\n\u003ch3 style=\"border-bottom: none; margin-bottom: 1em;\"\u003e🌳 2) Keyword Overview\u003c/h3\u003e\n\n\u003cp align=\"center\" style=\"margin-bottom: 0.5em;\"\u003e\n  \u003cstrong\u003eKeyword Overview Layout\u003c/strong\u003e\n\u003c/p\u003e\n\u003cp align=\"center\" style=\"font-family: monospace; line-height: 1.4; white-space: pre;\"\u003e\n[ Left: File Navigation \u0026amp; Keyword Filters ]   [ Middle: Keyword List ]   [ Right: Keyword Details ]\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./static/keyword_usage.png\" alt=\"graph_view\" width=\"900\"/\u003e\n\u003c/p\u003e\n\n\u003cbr\u003e\n\n\u003ch4 style=\"border-bottom: none; margin-bottom: 0.5em;\"\u003e⬅️ Left Side – Navigation \u0026amp; Filters\u003c/h4\u003e\n\n- \u003cstrong\u003eFile Selection:\u003c/strong\u003e At the top, a dropdown lets you select a file. The current VS Code workspace is used as root, and all\n  \u003ccode\u003e.robot\u003c/code\u003e and \u003ccode\u003e.resource\u003c/code\u003e files are available.\n- \u003cstrong\u003eType Filter:\u003c/strong\u003e Choose which group of keywords to display for the selected file:\n    - \u003cstrong\u003eAll Keywords:\u003c/strong\u003e Shows every keyword that is either defined in or used by the selected file.\n    - \u003cstrong\u003eInitialized Keywords:\u003c/strong\u003e Only keywords that are defined/implemented in the selected file.\n    - \u003cstrong\u003eCalled Keywords:\u003c/strong\u003e Only keywords that are used in the selected file but defined elsewhere.\n- \u003cstrong\u003eGlobal Filter:\u003c/strong\u003e Jump directly to common problem areas across the entire project:\n    - \u003cstrong\u003eKeywords without Documentation:\u003c/strong\u003e Keywords that are missing documentation.\n    - \u003cstrong\u003eUnused Keywords:\u003c/strong\u003e Keywords that are never called in any analyzed file.\n    - \u003cstrong\u003ePotential Keyword Duplicates:\u003c/strong\u003e Keywords that may duplicate or closely resemble existing keywords.\n\n\u003cbr\u003e\n\n\u003ch4 style=\"border-bottom: none; margin-bottom: 0.5em;\"\u003e📊 Middle – Keyword List\u003c/h4\u003e\n\nThe middle section lists all keywords found in the selected file and shows key information about each of them:\n\n- \u003cstrong\u003eOrigin indicator:\u003c/strong\u003e A color-coded label to the left of the keyword name shows where the keyword comes from:\n    - \u003cstrong\u003eU\u003c/strong\u003e: User-defined keyword.\n    - \u003cstrong\u003eE\u003c/strong\u003e: External keyword (e.g. from \u003ccode\u003eBuiltIn\u003c/code\u003e or libraries like \u003ccode\u003eBrowser\u003c/code\u003e).\n- \u003cstrong\u003eDefinition location:\u003c/strong\u003e The file in which the keyword is defined.\n- \u003cstrong\u003eFile-local usage count:\u003c/strong\u003e How often the keyword is used (called) in the selected file.\n- \u003cstrong\u003eProject-wide usage count:\u003c/strong\u003e How often the keyword is used across all \u003ccode\u003e.robot\u003c/code\u003e and \u003ccode\u003e.resource\u003c/code\u003e files in the current project.\n\n\u003cbr\u003e\n\n\u003ch4 style=\"border-bottom: none; margin-bottom: 0.5em;\"\u003e➡️ Right Side – Keyword Details\u003c/h4\u003e\n\nWhen you select a keyword (by clicking a row in the middle table), the right panel shows detailed information:\n\n- \u003cstrong\u003eDocumentation:\u003c/strong\u003e The keyword’s documentation as defined in the source code.\n- \u003cstrong\u003eUsage across files:\u003c/strong\u003e In which \u003ccode\u003e.robot\u003c/code\u003e and \u003ccode\u003e.resource\u003c/code\u003e files the keyword is used, and how often in each file.\n- \u003cstrong\u003eSimilarity analysis:\u003c/strong\u003e A list of up to five keywords that are most similar to the selected one, based on its name and source code using term-frequency-based similarity.\n\n\u003cbr\u003e\n\n---\n\n\u003ch3 style=\"border-bottom: none; margin-bottom: 1em;\"\u003e🛡️ 3) Robocop\u003c/h3\u003e\n\nThe **Robocop** view integrates the `https://robocop.readthedocs.io/` linter directly into RoboView, so you can spot and fix structural and style issues in your Robot Framework tests without leaving VS Code.\n\n\u003cp align=\"center\" style=\"margin-bottom: 0.5em;\"\u003e\n  \u003cstrong\u003eRobocop Issues Layout\u003c/strong\u003e\n\u003c/p\u003e\n\u003cp align=\"center\" style=\"font-family: monospace; line-height: 1.4; white-space: pre;\"\u003e\n[ Left: Error Overview ]   [ Middle: Error List ]   [ Right: Error Details ]\n\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"./static/robocop.png\" alt=\"robocop_issues\" width=\"900\"/\u003e\n\u003c/p\u003e\n\n\n\u003cbr\u003e\n\n### How it works\n\n- **Left: Error Overview**  \n  The left panel shows a compact **overview of all detected issues**, for example:\n    - Total number of Robocop findings\n    - Issues grouped by **rule** or **category**\n    - A quick way to see which types of problems are most common\n      This helps you understand the overall state of your project at a glance.\n- **Middle: Error List**  \n  The middle panel contains the **list of individual Robocop issues**.  \n  Each entry typically shows:\n    - The **file** where the issue was found\n    - The **rule id** and short **message**\n    - The **line** number in the file\n\n  You can scroll through this list and select a specific issue to inspect it in detail.\n\n- **Right: Error Details**\n  The right panel displays **details for the currently selected issue**, including:\n    - The full Robocop message\n    - The rule id and its description\n    - The file and line information\n    - Additional context that helps you understand why this issue was reported\n\n\u003cbr\u003e\n\n---\n\n\u003ch2 style=\"border-bottom: none; margin-bottom: 1em;\"\u003e🔮 Outlook\u003c/h2\u003e\n\nRoboView is an actively evolving project. ✨  \nWe’re continuously adding new features, polishing existing workflows, and exploring fresh ideas to make working with Robot Framework even more enjoyable. 💡\n\nWe’re happy to have you along for the journey – stay tuned for new releases and improvements! 🚀","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviadee%2Frobotframework-roboview","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fviadee%2Frobotframework-roboview","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fviadee%2Frobotframework-roboview/lists"}