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 https://static.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 https://img.shields.io/badge/code%20style-black-000000.svg

Python Client library for interacting with Community, Developer, and Enterprise Editions SonarQube’s REST APIs and SonarCloud’s REST APIs.

python-sonarqube-api provides a simple interface for clients to interact with SonarQube via the REST API.

Editions

There are two editions of python-sonarqube-api:

Notice: Professional Edition’s extra features have been remarked by using Only available on the professional edition in API Document.

Differences

Community Edition

Professional Edition

License

GNU AGPLv3 License

MIT License

Commercial Use

No

Yes

Supported APIs (SonarQube Web APIs)

40

more than 280

Compatibility (SonarQube Versions)

7.9.x - 8.9.x

7.9.x - 10.x

Payment only needs to be made once, and library updates will be provided for free.

Change Log

Community Edition

See the CHANGELOG-CE.md file for Community Edition.

Professional Edition

See the CHANGELOG-PE.md file for Professional Edition.

Installation

Community Edition

The easiest way to install the latest version is by using pip to pull it from PyPI:

pip install  --upgrade python-sonarqube-api

Professional Edition

Use command pip to install the Python wheel or source package, Use –force-reinstall to force an installation If necessary:

pip install python_sonarqube_pro_api-x.y.z-py3-none-any.whl

where x, y, and z should be replaced by the current version number.

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.

Usage

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

sonar = SonarQubeClient(sonarqube_url="http://localhost:9000", username='admin', password='admin')

Sonar authentication tokens can also be used in place of username and password:

sonar = SonarQubeClient(sonarqube_url="http://localhost:9000", token='*****************')

API example

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

Licensing

See the LICENSE file for licensing information as it pertains to files in this repository.

Project details


Download files

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

Source Distribution

python_sonarqube_api-2.0.5.tar.gz (31.4 kB view details)

Uploaded Source

Built Distribution

python_sonarqube_api-2.0.5-py3-none-any.whl (42.0 kB view details)

Uploaded Python 3

File details

Details for the file python_sonarqube_api-2.0.5.tar.gz.

File metadata

  • Download URL: python_sonarqube_api-2.0.5.tar.gz
  • Upload date:
  • Size: 31.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for python_sonarqube_api-2.0.5.tar.gz
Algorithm Hash digest
SHA256 b7a785c10d4ae3532c592f6dfe3b5cc4cf489888c2995d822e5f80fdb8259219
MD5 9297c7925243e408627f906a544e40d1
BLAKE2b-256 c4155190c9ef8ddfc91df47cc3b42bace763e7eeca59e96be07e6f7545901a87

See more details on using hashes here.

File details

Details for the file python_sonarqube_api-2.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for python_sonarqube_api-2.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 95466a214d543b3ef0739a403448908a746d78f26766e031be3cd60463e319ef
MD5 f26fd8fe75e34cee53ba45950ca214ec
BLAKE2b-256 bbf8b20591532f40d93eaa086e0d43998d8d5f24fc02a5bd8034ffc8cb841c80

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page