sonarqube-client 0.0.5

Package that creates simple APIs to interact with SonarQube

SonarQube Client

API Calls to interact with SonarQube
Explore the docs »

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

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.

(back to top)

Built With

(back to top)

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

   git clone https://github.com/peterdeames/sonarqube-client.git
   

2. Install Python packages

   pip install -r requirements.txt
   

(back to top)

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 for a full list of proposed features (and known issues).

(back to top)

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

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/peterdeames/sonarqube-client

(back to top)