Metadata-Version: 2.1
Name: redcoffee
Version: 0.7
Summary: A command-line tool to generate PDF for SonarQube Reports
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: click
Requires-Dist: reportlab
Requires-Dist: pytest
Requires-Dist: requests
Requires-Dist: setuptools

# RedCoffee

RedCoffee is a command-line tool designed to manage SonarQube reports easily. It allows you to configure the SonarQube analysis token and generate PDF reports from SonarQube analysis data.

## Installation

To install RedCoffee, you can use pip. First, ensure you have Python and pip installed on your system. Then, you can install RedCoffee directly from PyPI:

```bash
pip install redcoffee
```

## Pre Requisites

The SonarQube analysis for the project should have been already done.

## Usage

Please run the following command to generate the PDF Report

```bash
redcoffee generatepdf --host={YOUR_SONARQUBE_HOST_NAME} --project={SONARQUBE_PROJECT_KEY} --path={PATH WHERE PDF FILE IS TO BE STORED} --token={SONARQUBE_GLOBAL_ANALYSIS_TOKEN}
```

## Maintenance

Please reach out to @Anubhav9 on Github

