Metadata-Version: 2.4
Name: simple-sonarqube-api
Version: 0.1.6
Summary: Simple Python client for SonarQube Web API
Author: M.E. (Mikehenrytech)
License-Expression: GPL-3.0-only
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.32
Provides-Extra: dev
Requires-Dist: pytest>=8; extra == "dev"
Requires-Dist: responses>=0.25; extra == "dev"
Requires-Dist: ruff>=0.6; extra == "dev"
Requires-Dist: mypy>=1.11; extra == "dev"
Requires-Dist: python-dotenv>=1.2.1; extra == "dev"
Dynamic: license-file

# simple-sonarqube-api
Sonarqube api python module


# Usage

# Build module

```bash
python -m venv .venv

```
## Linux/macOS
```bash
source .venv/bin/activate
```

## Windows (PowerShell)
```bash
# .\.venv\Scripts\Activate.ps1
```

## build
```bash
python -m pip install -U pip
pip install -e .
```


## Example

Install module
```bash
$ pip install simple-sonarqube-api
```

Code example
```python
from simple_sonarqube_api.client import SonarQubeClient

client = SonarQubeClient(
    base_url="https://sonar.midominio",
    token="squ_xxxxxxxxx"
)

assert client.is_authenticated()

issues = list(client.iter_issues(types="VULNERABILITY", resolved=False))
evidence = client.get_issue_code_evidence(issues[0]["key"], context_lines=3)

print(evidence["snippet"])
```

## Check bandit
```bash
$ bandit -r src/simple_sonarqube_api
```
