<a name="readme-top"></a>
<div align="center">
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![Bugs][bugs-badge]][sonar-url]
[![Code Smells][codesmells-badge]][sonar-url]
[![Code Coverage][coverage-badge]][sonar-url]
[![Lines of Code][loc-badge]][sonar-url]
[![Duplicated Lines][duplicatedlines-badge]][sonar-url]
[![Vulnerabilities][vulnerabilities-badge]][sonar-url]
[![Quality Gate Status][qualitygate-badge]][sonar-url]
[![Maintainability Rating][maintainability-badge]][sonar-url]
[![Reliability Rating][reliability-badge]][sonar-url]
[![Security Rating][security-badge]][sonar-url]
<!-- PROJECT LOGO -->
<br />
<h2 align="center">SonarQube Client</h2>
<p align="center">
API Calls to interact with SonarQube
<br />
<a href="https://github.com/peterdeames/sonarqube-client"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/peterdeames/sonarqube-client/issues">Report Bug</a>
·
<a href="https://github.com/peterdeames/sonarqube-client/issues">Request Feature</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<li><a href="#acknowledgments">Acknowledgments</a></li>
</ol>
</details>
<!-- ABOUT THE PROJECT -->
## About The Project
This project is collection of API calls that interact with SonarQube to help maintain daily operations such as create projects, delete projects, rename projects.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
### Built With
[![Python][Python.org]][Python-url]
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
To get a local copy up and running follow these simple example steps.
### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* python
### Installation
1. Clone the repo
```sh
git clone https://github.com/peterdeames/sonarqube-client.git
```
2. Install Python packages
```sh
pip install -r requirements.txt
```
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- USAGE EXAMPLES -->
<!-- ## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
<!-- ROADMAP -->
## Roadmap
- [ ] Create, Delete Projects
- [ ] Create Permission
- [ ] Add group to permission
- [ ] Auditing
- [ ] Get SonarQube Health
- [ ] Ping SonarQube
- [ ] Get Current Version
- [ ] LOC Count
- [ ] Get Languages
- [ ] Get Plugins
See the [open issues](https://github.com/peterdeames/sonarqube-client/issues) for a full list of proposed features (and known issues).
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTRIBUTING -->
## Contributing
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
Don't forget to give the project a star! Thanks again!
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- LICENSE -->
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
Project Link: [https://github.com/peterdeames/sonarqube-client](https://github.com/peterdeames/sonarqube-client)
<p align="right">(<a href="#readme-top">back to top</a>)</p>
<!-- ACKNOWLEDGMENTS -->
<!-- ## Acknowledgments
* []()
* []()
* []()
<p align="right">(<a href="#readme-top">back to top</a>)</p> -->
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/peterdeames/sonarqube-client.svg?style=for-the-badge
[contributors-url]: https://github.com/peterdeames/sonarqube-client/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/peterdeames/sonarqube-client.svg?style=for-the-badge
[forks-url]: https://github.com/peterdeames/sonarqube-client/network/members
[stars-shield]: https://img.shields.io/github/stars/peterdeames/sonarqube-client.svg?style=for-the-badge
[stars-url]: https://github.com/peterdeames/sonarqube-client/stargazers
[issues-shield]: https://img.shields.io/github/issues/peterdeames/sonarqube-client.svg?style=for-the-badge
[issues-url]: https://github.com/peterdeames/sonarqube-client/issues
[license-shield]: https://img.shields.io/github/license/peterdeames/sonarqube-client.svg?style=for-the-badge
[license-url]: https://github.com/peterdeames/sonarqube-client/blob/master/LICENSE.txt
[product-screenshot]: images/screenshot.png
[Python.org]: https://img.shields.io/badge/Python-0769AD?style=for-the-badge&logo=python&logoColor=white
[Python-url]: https://www.python.org
[sonar-url]: https://sonarcloud.io/summary/new_code?id=peterdeames_sonarqube-client
[bugs-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=bugs
[codesmells-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=code_smells
[coverage-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=coverage
[loc-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=ncloc
[duplicatedlines-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=duplicated_lines_density
[vulnerabilities-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=vulnerabilities
[qualitygate-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=alert_status
[maintainability-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=sqale_rating
[reliability-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=reliability_rating
[security-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=security_rating
Raw data
{
"_id": null,
"home_page": "https://github.com/peterdeames/sonarqube-api",
"name": "sonarqube-client",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "sonar sonarqube",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/b9/af/0f1f920da612841930c002c2c540d51a448fab8cde43a1fe6bec24a92ab1/sonarqube-client-0.0.5.tar.gz",
"platform": null,
"description": "<a name=\"readme-top\"></a>\n<div align=\"center\">\n\n<!-- PROJECT SHIELDS -->\n<!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n-->\n[![Contributors][contributors-shield]][contributors-url]\n[![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url]\n[![Issues][issues-shield]][issues-url]\n[![MIT License][license-shield]][license-url]\n\n[![Bugs][bugs-badge]][sonar-url]\n[![Code Smells][codesmells-badge]][sonar-url]\n[![Code Coverage][coverage-badge]][sonar-url]\n[![Lines of Code][loc-badge]][sonar-url]\n[![Duplicated Lines][duplicatedlines-badge]][sonar-url]\n[![Vulnerabilities][vulnerabilities-badge]][sonar-url]\n\n[![Quality Gate Status][qualitygate-badge]][sonar-url]\n[![Maintainability Rating][maintainability-badge]][sonar-url]\n[![Reliability Rating][reliability-badge]][sonar-url]\n[![Security Rating][security-badge]][sonar-url]\n\n\n<!-- PROJECT LOGO -->\n<br />\n<h2 align=\"center\">SonarQube Client</h2>\n\n <p align=\"center\">\n API Calls to interact with SonarQube\n <br />\n <a href=\"https://github.com/peterdeames/sonarqube-client\"><strong>Explore the docs \u00bb</strong></a>\n <br />\n <br />\n <a href=\"https://github.com/peterdeames/sonarqube-client/issues\">Report Bug</a>\n \u00b7\n <a href=\"https://github.com/peterdeames/sonarqube-client/issues\">Request Feature</a>\n </p>\n</div>\n\n\n\n<!-- TABLE OF CONTENTS -->\n<details>\n <summary>Table of Contents</summary>\n <ol>\n <li>\n <a href=\"#about-the-project\">About The Project</a>\n <ul>\n <li><a href=\"#built-with\">Built With</a></li>\n </ul>\n </li>\n <li>\n <a href=\"#getting-started\">Getting Started</a>\n <ul>\n <li><a href=\"#prerequisites\">Prerequisites</a></li>\n <li><a href=\"#installation\">Installation</a></li>\n </ul>\n </li>\n <li><a href=\"#usage\">Usage</a></li>\n <li><a href=\"#roadmap\">Roadmap</a></li>\n <li><a href=\"#contributing\">Contributing</a></li>\n <li><a href=\"#license\">License</a></li>\n <li><a href=\"#contact\">Contact</a></li>\n <li><a href=\"#acknowledgments\">Acknowledgments</a></li>\n </ol>\n</details>\n\n\n\n<!-- ABOUT THE PROJECT -->\n## About The Project\n\nThis project is collection of API calls that interact with SonarQube to help maintain daily operations such as create projects, delete projects, rename projects.\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n### Built With\n\n[![Python][Python.org]][Python-url]\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- GETTING STARTED -->\n## Getting Started\n\n\nTo get a local copy up and running follow these simple example steps.\n\n### Prerequisites\n\nThis is an example of how to list things you need to use the software and how to install them.\n* python\n\n### Installation\n\n1. Clone the repo\n ```sh\n git clone https://github.com/peterdeames/sonarqube-client.git\n ```\n2. Install Python packages\n ```sh\n pip install -r requirements.txt\n ```\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- USAGE EXAMPLES -->\n<!-- ## Usage\n\nUse this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.\n\n_For more examples, please refer to the [Documentation](https://example.com)_\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p> -->\n\n\n\n<!-- ROADMAP -->\n## Roadmap\n\n- [ ] Create, Delete Projects\n- [ ] Create Permission\n - [ ] Add group to permission\n- [ ] Auditing\n - [ ] Get SonarQube Health\n - [ ] Ping SonarQube\n - [ ] Get Current Version\n - [ ] LOC Count\n - [ ] Get Languages\n - [ ] Get Plugins\n\nSee the [open issues](https://github.com/peterdeames/sonarqube-client/issues) for a full list of proposed features (and known issues).\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- CONTRIBUTING -->\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag \"enhancement\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- LICENSE -->\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- CONTACT -->\n## Contact\n\nProject Link: [https://github.com/peterdeames/sonarqube-client](https://github.com/peterdeames/sonarqube-client)\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p>\n\n\n\n<!-- ACKNOWLEDGMENTS -->\n<!-- ## Acknowledgments\n\n* []()\n* []()\n* []()\n\n<p align=\"right\">(<a href=\"#readme-top\">back to top</a>)</p> -->\n\n\n\n<!-- MARKDOWN LINKS & IMAGES -->\n<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->\n[contributors-shield]: https://img.shields.io/github/contributors/peterdeames/sonarqube-client.svg?style=for-the-badge\n[contributors-url]: https://github.com/peterdeames/sonarqube-client/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/peterdeames/sonarqube-client.svg?style=for-the-badge\n[forks-url]: https://github.com/peterdeames/sonarqube-client/network/members\n[stars-shield]: https://img.shields.io/github/stars/peterdeames/sonarqube-client.svg?style=for-the-badge\n[stars-url]: https://github.com/peterdeames/sonarqube-client/stargazers\n[issues-shield]: https://img.shields.io/github/issues/peterdeames/sonarqube-client.svg?style=for-the-badge\n[issues-url]: https://github.com/peterdeames/sonarqube-client/issues\n[license-shield]: https://img.shields.io/github/license/peterdeames/sonarqube-client.svg?style=for-the-badge\n[license-url]: https://github.com/peterdeames/sonarqube-client/blob/master/LICENSE.txt\n[product-screenshot]: images/screenshot.png\n[Python.org]: https://img.shields.io/badge/Python-0769AD?style=for-the-badge&logo=python&logoColor=white\n[Python-url]: https://www.python.org\n\n[sonar-url]: https://sonarcloud.io/summary/new_code?id=peterdeames_sonarqube-client\n[bugs-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=bugs\n[codesmells-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=code_smells\n[coverage-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=coverage\n[loc-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=ncloc\n[duplicatedlines-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=duplicated_lines_density\n[vulnerabilities-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=vulnerabilities\n\n[qualitygate-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=alert_status\n[maintainability-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=sqale_rating\n[reliability-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=reliability_rating\n[security-badge]: https://sonarcloud.io/api/project_badges/measure?project=peterdeames_sonarqube-client&metric=security_rating\n",
"bugtrack_url": null,
"license": "",
"summary": "Package that creates simple APIs to interact with SonarQube",
"version": "0.0.5",
"split_keywords": [
"sonar",
"sonarqube"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "4dbab4d4e28afac981c3275302f5f59d",
"sha256": "c82f89b05b6f01d7eb1380d0813315d8a3b155fb43ebe31da4ec5d5ed44575e2"
},
"downloads": -1,
"filename": "sonarqube_client-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4dbab4d4e28afac981c3275302f5f59d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8479,
"upload_time": "2022-11-30T10:06:02",
"upload_time_iso_8601": "2022-11-30T10:06:02.915059Z",
"url": "https://files.pythonhosted.org/packages/76/06/bdcfd8704985f7e7c88b1b0299e44113e9a51c9f46a7be33b07342f9302f/sonarqube_client-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "0c2ccb15483cb4b69cc6f2a550ee7f04",
"sha256": "6c09e2773241a7775d69076ddf980216b5438a8fcd686d2bd51fb4017ed32331"
},
"downloads": -1,
"filename": "sonarqube-client-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "0c2ccb15483cb4b69cc6f2a550ee7f04",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10055,
"upload_time": "2022-11-30T10:06:04",
"upload_time_iso_8601": "2022-11-30T10:06:04.347818Z",
"url": "https://files.pythonhosted.org/packages/b9/af/0f1f920da612841930c002c2c540d51a448fab8cde43a1fe6bec24a92ab1/sonarqube-client-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-11-30 10:06:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "peterdeames",
"github_project": "sonarqube-api",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "setuptools",
"specs": []
},
{
"name": "build",
"specs": []
},
{
"name": "wheel",
"specs": []
},
{
"name": "sphinx",
"specs": []
},
{
"name": "twine",
"specs": []
},
{
"name": "requests",
"specs": []
},
{
"name": "pylint",
"specs": []
},
{
"name": "bandit",
"specs": []
},
{
"name": "nose",
"specs": []
},
{
"name": "nose2",
"specs": []
},
{
"name": "coverage",
"specs": []
},
{
"name": "tabulate",
"specs": []
}
],
"lcname": "sonarqube-client"
}
JSON
