Python3 library to statically analyze software using SonarLint and collect data in a Python Object, CSV, or JSON data format
Project description
# friendly_sonar
[](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
```
[](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 | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Built Distribution
Close
Hashes for friendly_sonar-0.0.1.dev4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4a963f6c10cdca49cac47bf6b194d78caf1c3f36780f8a7733b417d7b11b416a |
|
MD5 | c026c24d56cbebd5d623357932d07cbc |
|
BLAKE2-256 | e8759a5ff736e7cb3852a319ac022b02936a1ada3d0e64ff1571f7e79b2dfe4a |