Skip to main content

Robot Framework code analysis tool

Project description

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:

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:

sherlock --output <path to output.xml file> <path to source code repository>

To analyze external library/resource use --resource option:

sherlock --output output.xml --resource SeleniumLibrary src/
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:

sherlock --report print
sherlock --report html

--report accepts comma separated list of reports:

sherlock --report print,html,json

BuiltIn library

To show analysis of BuiltIn libraries use --include-builtin flag:

sherlock --include-builtin src/

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

robotframework-sherlock-0.3.0.tar.gz (32.4 kB view details)

Uploaded Source

Built Distribution

robotframework_sherlock-0.3.0-py3-none-any.whl (50.2 kB view details)

Uploaded Python 3

File details

Details for the file robotframework-sherlock-0.3.0.tar.gz.

File metadata

File hashes

Hashes for robotframework-sherlock-0.3.0.tar.gz
Algorithm Hash digest
SHA256 5f8953776119d0ffe16fa5b7133355930bc880a2d56a9dcf989d21ff41667c1f
MD5 18fc8ef2ca052c200f254c1ce1324f1c
BLAKE2b-256 c7668c499136e6719572e0bc6ba7d75b6a2ca3b21a1e19e24178bb935ef5cc38

See more details on using hashes here.

File details

Details for the file robotframework_sherlock-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for robotframework_sherlock-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1dbf4fcb2252e2d175140cae14355f2fce2aa4f208bfa48f0de555867f225556
MD5 9311a06649067c213a240ccc029b8853
BLAKE2b-256 af0f4dc0f085295c3eb17f2343fa01823e51275b8d1dda012d9802099edc21f6

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page