Skip to main content

A command-line tool to generate PDF for SonarQube Reports

Project description

PyPI Downloads

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-2.5.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

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

redcoffee-2.5-py3-none-any.whl (10.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for redcoffee-2.5.tar.gz
Algorithm Hash digest
SHA256 5551ea02ddf6916f60893ee7a901fcbe1a1125a42abe1831dd40c91cd6f49e2a
MD5 44ff280886e917c5ab293efa70b73d3e
BLAKE2b-256 4c4ce879d1b29b026ea4b89c9c00feffc6f0e66d1cbcc35d5e1f9dbff9421973

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for redcoffee-2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 e0720dabc89e7cd86b03556a5dcc6d87536e3c026be804f86a4cf28e3842d6e0
MD5 65423e0e5b049b4ef0147ab83bfe5998
BLAKE2b-256 1dfce5bf7d832ed818bd7858d1e4815aec8605303a918d82cf71ed5007d16ef3

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