Skip to main content

Python3 library to statically analyze software using SonarLint and collect data in a Python Object, CSV, or JSON data format

Project description

# friendly_sonar

[![Build Status](https://travis-ci.org/luiscruz/friendly_sonar.svg?branch=master)](https://travis-ci.org/luiscruz/friendly_sonar)

Python3 library to statically analyze software using [SonarLint](http://www.sonarlint.org/) and collect data in a Python Object, CSV, or JSON data format.

Website: https://luiscruz.github.io/friendly_sonar/

## Install

1. Download [SonarQube CLI](https://bintray.com/sonarsource/Distribution/org.sonarsource.sonarlint-cli/_latestVersion)

2. A) Add environment variable `$SONARLINT_HOME` with directory of your sonar lint installation:

```
export SONARLINT_HOME='~/sonarlint-cli-2.1.0.566'
```
**OR**

2. B) Add environment variable `$SONARLINT_HOME` with directory of your sonar lint installation:

```
export PATH=~/sonarlint-cli-2.1.0.566/bin:$PATH
```

3. Install Python library

```
$pip install friendly_sonar
```

## Usage

```
import friendly_sonar.lint

# run sonar on current directory
results = friendly_sonar("./")
print results

```

## Contributing

Feel free to create pull requests.
Be sure that your code passes our checkers:

```
$tox -e py36
```
### Tests

Tests are still not being made properly.
So far you can check whether it is working by running:

```
$python -m friendly_sonar.lint
```



Project details


Release history Release notifications

This version
History Node

0.0.1.dev4

History Node

0.0.1.dev2

History Node

0.0.1.dev1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
friendly_sonar-0.0.1.dev4-py3-none-any.whl (5.1 kB) Copy SHA256 hash SHA256 Wheel py3 Sep 19, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page