Skip to main content

Python wrapper for the SonarQube and SonarCloud API.

Project description

https://img.shields.io/pypi/pyversions/python-sonarqube-api.svg https://img.shields.io/pypi/v/python-sonarqube-api.svg https://pepy.tech/badge/python-sonarqube-api/month https://sonarcloud.io/api/project_badges/measure?project=shijl0925_python-sonarqube-api&metric=alert_status https://img.shields.io/github/license/shijl0925/python-sonarqube-api.svg

Python wrapper for the SonarQube 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 v7.9.x Community Edition and SonarCloud Server.

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='*****************')

API example

The example documentation for SonarQubeClient APIs is available on API examples.

Project details


Download files

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

Files for python-sonarqube-api, version 1.1.5
Filename, size File type Python version Upload date Hashes
Filename, size python_sonarqube_api-1.1.5-py3-none-any.whl (67.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size python-sonarqube-api-1.1.5.tar.gz (40.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page