# Sherlock
The tool for analyzing Robot Framework code in terms of not used code, code complexity or performance issues.
> **Note**
>
> The tool is in the ***Alpha*** state, which means it may be unstable and should be used at your own risk. Some
> features may be broken and there are still many things to be developed. If you find anything unexpected, or you have ideas for improvements
> not listed in GitHub issues, please open an new issue.
## Installation
You can install the latest version of Sherlock simply by running:
```commandline
pip install -U robotframework-sherlock
```
Sherlock requires Python 3.8+.
## Usage
Sherlock can prepare analysis based on your source code alone. However, it's currently highly recommended to also include
output of test execution.
Run Sherlock with:
```commandline
sherlock --output <path to output.xml file> <path to source code repository>
```
To analyze external library/resource use ``--resource`` option:
```commandline
sherlock --output output.xml --resource SeleniumLibrary src/
```
```commandline
sherlock --output output.xml --resource external_repository_used_in_tests/ src/
```
## Reports
Sherlock by default prints the output. You can configure what reports are produced by sherlock using ``--report`` option:
```commandline
sherlock --report print
```
```commandline
sherlock --report html
```
``--report`` accepts comma separated list of reports:
```commandline
sherlock --report print,html,json
```
## BuiltIn library
To show analysis of BuiltIn libraries use ``--include-builtin`` flag:
```commandline
sherlock --include-builtin src/
```
Raw data
{
"_id": null,
"home_page": "https://github.com/bhirsz/robotframework-sherlock",
"name": "robotframework-sherlock",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "robotframework automation testautomation testing qa",
"author": "Bartlomiej Hirsz, Mateusz Nojek",
"author_email": "bartek.hirsz@gmail.com, matnojek@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c7/66/8c499136e6719572e0bc6ba7d75b6a2ca3b21a1e19e24178bb935ef5cc38/robotframework-sherlock-0.3.0.tar.gz",
"platform": "any",
"description": "# Sherlock\nThe tool for analyzing Robot Framework code in terms of not used code, code complexity or performance issues.\n\n> **Note**\n> \n> The tool is in the ***Alpha*** state, which means it may be unstable and should be used at your own risk. Some \n> features may be broken and there are still many things to be developed. If you find anything unexpected, or you have ideas for improvements \n> not listed in GitHub issues, please open an new issue.\n\n## Installation\n\nYou can install the latest version of Sherlock simply by running:\n```commandline\npip install -U robotframework-sherlock\n```\n\nSherlock requires Python 3.8+.\n\n## Usage\n\nSherlock can prepare analysis based on your source code alone. However, it's currently highly recommended to also include\noutput of test execution.\n\nRun Sherlock with:\n```commandline\nsherlock --output <path to output.xml file> <path to source code repository>\n```\n\nTo analyze external library/resource use ``--resource`` option:\n```commandline\nsherlock --output output.xml --resource SeleniumLibrary src/\n```\n```commandline\nsherlock --output output.xml --resource external_repository_used_in_tests/ src/\n```\n\n## Reports\nSherlock by default prints the output. You can configure what reports are produced by sherlock using ``--report`` option:\n```commandline\nsherlock --report print\n```\n```commandline\nsherlock --report html\n```\n``--report`` accepts comma separated list of reports:\n```commandline\nsherlock --report print,html,json\n```\n\n## BuiltIn library\n\nTo show analysis of BuiltIn libraries use ``--include-builtin`` flag:\n```commandline\nsherlock --include-builtin src/\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Robot Framework code analysis tool",
"version": "0.3.0",
"project_urls": {
"Download": "https://pypi.org/project/robotframework-sherlock",
"Homepage": "https://github.com/bhirsz/robotframework-sherlock"
},
"split_keywords": [
"robotframework",
"automation",
"testautomation",
"testing",
"qa"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "af0f4dc0f085295c3eb17f2343fa01823e51275b8d1dda012d9802099edc21f6",
"md5": "9311a06649067c213a240ccc029b8853",
"sha256": "1dbf4fcb2252e2d175140cae14355f2fce2aa4f208bfa48f0de555867f225556"
},
"downloads": -1,
"filename": "robotframework_sherlock-0.3.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9311a06649067c213a240ccc029b8853",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 50200,
"upload_time": "2023-08-14T08:08:19",
"upload_time_iso_8601": "2023-08-14T08:08:19.479152Z",
"url": "https://files.pythonhosted.org/packages/af/0f/4dc0f085295c3eb17f2343fa01823e51275b8d1dda012d9802099edc21f6/robotframework_sherlock-0.3.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c7668c499136e6719572e0bc6ba7d75b6a2ca3b21a1e19e24178bb935ef5cc38",
"md5": "18fc8ef2ca052c200f254c1ce1324f1c",
"sha256": "5f8953776119d0ffe16fa5b7133355930bc880a2d56a9dcf989d21ff41667c1f"
},
"downloads": -1,
"filename": "robotframework-sherlock-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "18fc8ef2ca052c200f254c1ce1324f1c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 32434,
"upload_time": "2023-08-14T08:08:21",
"upload_time_iso_8601": "2023-08-14T08:08:21.040063Z",
"url": "https://files.pythonhosted.org/packages/c7/66/8c499136e6719572e0bc6ba7d75b6a2ca3b21a1e19e24178bb935ef5cc38/robotframework-sherlock-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-14 08:08:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "bhirsz",
"github_project": "robotframework-sherlock",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "robotframework-sherlock"
}
JSON
