.. image:: https://img.shields.io/pypi/pyversions/python-sonarqube-api.svg
:target: https://pypi.python.org/pypi/python-sonarqube-api
.. image:: https://img.shields.io/pypi/v/python-sonarqube-api.svg
:target: https://pypi.python.org/pypi/python-sonarqube-api
.. image:: https://pepy.tech/badge/python-sonarqube-api
:target: https://pepy.tech/project/python-sonarqube-api
.. image:: https://static.pepy.tech/badge/python-sonarqube-api/month
:target: https://pepy.tech/project/python-sonarqube-api
.. image:: https://sonarcloud.io/api/project_badges/measure?project=shijl0925_python-sonarqube-api&metric=alert_status
:target: https://sonarcloud.io/dashboard?id=shijl0925_python-sonarqube-api
.. image:: https://img.shields.io/github/license/shijl0925/python-sonarqube-api.svg
:target: LICENSE
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
==========================================================================================================================================
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:
* Community Edition (CE) is available freely under the GNU Affero General Public License v3.0.
* Professional Edition (PE) includes `extra features <https://python-sonarqube-pro-api.readthedocs.io/en/latest/#api-reference>`_
that are more useful for developers with more than 280 interface functions. To use PE and get timely Email support and continuous updates,
please become a Purchaser(https://shijl0925.gumroad.com/l/nlokc) and become a subscriber(https://shijl0925.gumroad.com/subscribe).
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 | 40 | more than 280 |
| (SonarQube Web APIs)| | |
+---------------------+---------------------+-----------------------+
| Compatibility | 7.9.x - 8.9.x | 7.9.x - 10.x |
| (SonarQube Versions)| | |
+---------------------+---------------------+-----------------------+
**Payment only needs to be made once, and library updates will be provided for free.**
Change Log
==========
Community Edition
-----------------
See the `CHANGELOG-CE.md <https://github.com/shijl0925/python-sonarqube-api/blob/master/CHANGELOG-CE.md>`_ file for Community Edition.
Professional Edition
--------------------
See the `CHANGELOG-PE.md <https://github.com/shijl0925/python-sonarqube-api/blob/master/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
<https://python-sonarqube-pro-api.readthedocs.io/en/latest/>`_.
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 <https://paypal.me/shijialiang0925>`_
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
<https://python-sonarqube-pro-api.readthedocs.io/en/latest/examples.html>`_.
Licensing
-----------
See the `LICENSE <https://github.com/shijl0925/python-sonarqube-api/blob/master/LICENSE>`_ file for licensing information as it pertains to files in this repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/shijl0925/python-sonarqube-api",
"name": "python-sonarqube-api",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "api sonarqube sonar client wrapper sonarcloud",
"author": "Jialiang Shi",
"author_email": "kevin09254930sjl@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/c4/15/5190c9ef8ddfc91df47cc3b42bace763e7eeca59e96be07e6f7545901a87/python_sonarqube_api-2.0.5.tar.gz",
"platform": null,
"description": ".. image:: https://img.shields.io/pypi/pyversions/python-sonarqube-api.svg\n :target: https://pypi.python.org/pypi/python-sonarqube-api\n.. image:: https://img.shields.io/pypi/v/python-sonarqube-api.svg\n :target: https://pypi.python.org/pypi/python-sonarqube-api\n.. image:: https://pepy.tech/badge/python-sonarqube-api\n :target: https://pepy.tech/project/python-sonarqube-api\n.. image:: https://static.pepy.tech/badge/python-sonarqube-api/month\n :target: https://pepy.tech/project/python-sonarqube-api\n.. image:: https://sonarcloud.io/api/project_badges/measure?project=shijl0925_python-sonarqube-api&metric=alert_status\n :target: https://sonarcloud.io/dashboard?id=shijl0925_python-sonarqube-api\n.. image:: https://img.shields.io/github/license/shijl0925/python-sonarqube-api.svg\n :target: LICENSE\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n\n\n==========================================================================================================================================\nPython Client library for interacting with Community, Developer, and Enterprise Editions SonarQube's REST APIs and SonarCloud's REST APIs.\n==========================================================================================================================================\n\npython-sonarqube-api provides a simple interface for clients to interact with SonarQube via the REST API.\n\nEditions\n========\n\nThere are two editions of python-sonarqube-api:\n\n * Community Edition (CE) is available freely under the GNU Affero General Public License v3.0.\n * Professional Edition (PE) includes `extra features <https://python-sonarqube-pro-api.readthedocs.io/en/latest/#api-reference>`_\n that are more useful for developers with more than 280 interface functions. To use PE and get timely Email support and continuous updates,\n please become a Purchaser(https://shijl0925.gumroad.com/l/nlokc) and become a subscriber(https://shijl0925.gumroad.com/subscribe).\n\nNotice: Professional Edition's extra features have been remarked by using **Only available on the professional edition** in API Document.\n\n+---------------------+---------------------+-----------------------+\n| Differences | Community Edition | Professional Edition |\n+=====================+=====================+=======================+\n| License | GNU AGPLv3 License | MIT License |\n+---------------------+---------------------+-----------------------+\n| Commercial Use | No | Yes |\n+---------------------+---------------------+-----------------------+\n| Supported APIs | 40 | more than 280 |\n| (SonarQube Web APIs)| | |\n+---------------------+---------------------+-----------------------+\n| Compatibility | 7.9.x - 8.9.x | 7.9.x - 10.x |\n| (SonarQube Versions)| | |\n+---------------------+---------------------+-----------------------+\n\n**Payment only needs to be made once, and library updates will be provided for free.**\n\n\nChange Log\n==========\n\nCommunity Edition\n-----------------\n\nSee the `CHANGELOG-CE.md <https://github.com/shijl0925/python-sonarqube-api/blob/master/CHANGELOG-CE.md>`_ file for Community Edition.\n\nProfessional Edition\n--------------------\n\nSee the `CHANGELOG-PE.md <https://github.com/shijl0925/python-sonarqube-api/blob/master/CHANGELOG-PE.md>`_ file for Professional Edition.\n\n\nInstallation\n============\n\nCommunity Edition\n-----------------\n\nThe easiest way to install the latest version is by using pip to pull it from PyPI::\n\n pip install --upgrade python-sonarqube-api\n\nProfessional Edition\n--------------------\nUse command pip to install the Python wheel or source package, Use --force-reinstall to force an installation If necessary::\n\n pip install python_sonarqube_pro_api-x.y.z-py3-none-any.whl\n\nwhere x, y, and z should be replaced by the current version number.\n\nDocumentation\n=============\n\nThe full documentation for API is available on `readthedocs\n<https://python-sonarqube-pro-api.readthedocs.io/en/latest/>`_.\n\n\nCompatibility\n=============\n\n* This package is compatible Python versions 2.7, 3.3+.\n* Tested with SonarQube Community Edition 8.9.x LTS and SonarCloud Server.\n\nDonate\n======\n\ndonations are not mandatory but very welcomed\nIf you like my work and want to support development or buy me a coffee `PayPal Donate <https://paypal.me/shijialiang0925>`_\n\nUsage\n=====\n\nThe Client is easy to use, you just need to initialize it with the\nconnection parameters (default sonarqube url is http://localhost:9000).\n\nExample::\n\n from sonarqube import SonarQubeClient\n\n sonar = SonarQubeClient(sonarqube_url=\"http://localhost:9000\", username='admin', password='admin')\n\n\nSonar authentication tokens can also be used in place of username and password::\n\n sonar = SonarQubeClient(sonarqube_url=\"http://localhost:9000\", token='*****************')\n\n\nAPI example\n-----------\n\nThe example documentation for SonarQubeClient APIs is available on `API examples\n<https://python-sonarqube-pro-api.readthedocs.io/en/latest/examples.html>`_.\n\n\nLicensing\n-----------\nSee the `LICENSE <https://github.com/shijl0925/python-sonarqube-api/blob/master/LICENSE>`_ file for licensing information as it pertains to files in this repository.\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "Python wrapper for the SonarQube and SonarCloud API.",
"version": "2.0.5",
"project_urls": {
"Homepage": "https://github.com/shijl0925/python-sonarqube-api"
},
"split_keywords": [
"api",
"sonarqube",
"sonar",
"client",
"wrapper",
"sonarcloud"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bbf8b20591532f40d93eaa086e0d43998d8d5f24fc02a5bd8034ffc8cb841c80",
"md5": "f26fd8fe75e34cee53ba45950ca214ec",
"sha256": "95466a214d543b3ef0739a403448908a746d78f26766e031be3cd60463e319ef"
},
"downloads": -1,
"filename": "python_sonarqube_api-2.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f26fd8fe75e34cee53ba45950ca214ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 41979,
"upload_time": "2024-08-04T02:24:02",
"upload_time_iso_8601": "2024-08-04T02:24:02.073188Z",
"url": "https://files.pythonhosted.org/packages/bb/f8/b20591532f40d93eaa086e0d43998d8d5f24fc02a5bd8034ffc8cb841c80/python_sonarqube_api-2.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c4155190c9ef8ddfc91df47cc3b42bace763e7eeca59e96be07e6f7545901a87",
"md5": "9297c7925243e408627f906a544e40d1",
"sha256": "b7a785c10d4ae3532c592f6dfe3b5cc4cf489888c2995d822e5f80fdb8259219"
},
"downloads": -1,
"filename": "python_sonarqube_api-2.0.5.tar.gz",
"has_sig": false,
"md5_digest": "9297c7925243e408627f906a544e40d1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 31413,
"upload_time": "2024-08-04T02:24:03",
"upload_time_iso_8601": "2024-08-04T02:24:03.089464Z",
"url": "https://files.pythonhosted.org/packages/c4/15/5190c9ef8ddfc91df47cc3b42bace763e7eeca59e96be07e6f7545901a87/python_sonarqube_api-2.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-04 02:24:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shijl0925",
"github_project": "python-sonarqube-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "python-sonarqube-api"
}
JSON
