Skip to main content

A command-line tool to generate PDF for SonarQube Reports

Project description

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:

pip install redcoffee

Disclaimer: Due to some changes in response structure of SonarQube API, I had to push a non backward compatible change. Hence, it is advisable to upgrade to redcoffee=1.1

pip install redcoffee==1.1

Pre Requisites

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

Usage

Please run the following command to generate the PDF Report

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

Maintenance

Please reach out to @Anubhav9 on Github

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

redcoffee-1.8.tar.gz (7.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

redcoffee-1.8-py3-none-any.whl (8.4 kB view details)

Uploaded Python 3

File details

Details for the file redcoffee-1.8.tar.gz.

File metadata

  • Download URL: redcoffee-1.8.tar.gz
  • Upload date:
  • Size: 7.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for redcoffee-1.8.tar.gz
Algorithm Hash digest
SHA256 a8233db60d7b2965843beaa7570b7f26c87bada962065d9f0df12c48bfc6f34d
MD5 9a9001de77f27935626f2884bff7892e
BLAKE2b-256 a4be178f701ee9b39d11eb00610557ffb2497225cd05ab388de53e572a64cfc3

See more details on using hashes here.

File details

Details for the file redcoffee-1.8-py3-none-any.whl.

File metadata

  • Download URL: redcoffee-1.8-py3-none-any.whl
  • Upload date:
  • Size: 8.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.7

File hashes

Hashes for redcoffee-1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 0ec5d3fa774865880f96d56adf60ae7c154f05516cc36fa763a74e241f65f251
MD5 9c3922003e8e2f1900fb569b2a910b69
BLAKE2b-256 4518b7e4cc5becd21f37da20bc36f3e873e7261e4323f33169f1abf5ce977ddb

See more details on using hashes here.

Supported by

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