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
The full documentation for API is available on readthedocs.
- This package is compatible Python versions 2.7, 3.3+.
- Tested with SonarQube Community Edition 8.9.x LTS and SonarCloud Server.
donations are not mandatory but very welcomed If you like my work and want to support development or buy me a coffee PayPal Donate
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='*****************')
Example:
from sonarqube import SonarCloudClient
h = SonarCloudClient(sonarcloud_url="https://sonarcloud.io", token='*****************')
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='*****************')
The example documentation for SonarQubeClient APIs is available on API examples.