Python wrapper for the SonarQube and SonarCloud API.
Project description
Python wrapper for the SonarQube(Community Edition and Enterprise Edition) and SonarCloud API.
Installation
The easiest way to install the latest version is by using pip to pull it from PyPI:
pip install --upgrade python-sonarqube-api
You may also use Git to clone the repository from Github and install it manually:
git clone https://github.com/shijl0925/python-sonarqube-api.git cd python-sonarqube-api python setup.py install
Documentation
The full documentation for API is available on readthedocs.
Compatibility
This package is compatible Python versions 2.7, 3.3+.
Tested with SonarQube Community Edition 8.9.x LTS and SonarCloud Server.
Donate
donations are not mandatory but very welcomed If you like my work and want to support development or buy me a coffee PayPal Donate
Paypal
Wechat Pay
Alipay
Usage
For SonarQube Community Edition
The Client is easy to use, you just need to initialize it with the connection parameters (default sonarqube url is http://localhost:9000).
Example:
from sonarqube import SonarQubeClient h = SonarQubeClient(sonarqube_url="http://localhost:9000", username='admin', password='admin')
Sonar authentication tokens can also be used in place of username and password:
h = SonarQubeClient(sonarqube_url="http://localhost:9000", token='*****************')
For SonarCloud
Example:
from sonarqube import SonarCloudClient h = SonarCloudClient(sonarcloud_url="https://sonarcloud.io", token='*****************')
For SonarQube Enterprise Edition
The Client is easy to use, you just need to initialize it with the connection parameters (default sonarqube url is http://localhost:9000).
Example:
from sonarqube import SonarEnterpriseClient h = SonarEnterpriseClient(sonarqube_url="http://localhost:9000", username='admin', password='admin')
Sonar authentication tokens can also be used in place of username and password:
h = SonarEnterpriseClient(sonarqube_url="http://localhost:9000", token='*****************')
API example
The example documentation for SonarQubeClient APIs is available on API examples.
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.
Source Distribution
Built Distribution
Hashes for python-sonarqube-api-1.3.7.post0.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 73e59a5c1649fb477382ceb1583ee209375a9247ba7f248c6753a83161ba9a57 |
|
| MD5 | 8ee5a4ffff29b643f9861a087734312d |
|
| BLAKE2b-256 | 2e4d374436d95b75c731115feecf3aa42cef41ad62ef8a2c261a9d3a18c78085 |
Hashes for python_sonarqube_api-1.3.7.post0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2939f41321130845ad2807a010d7f6763a6838041a4d655adc11604b40e71069 |
|
| MD5 | 8cc438471b7012dbb8d07f9a88cdbd62 |
|
| BLAKE2b-256 | 9051e975dea6dad66473b5d4d71c4147fc60ffaf7f9fdd1891f56c92032f7a75 |
