Skip to main content

GitLab Security Reports Presenter

Project description

GitLab Security Reports Presenter

Provide build information and pretty-printed GitLab security reports in a CI pipeline


⚠ Exposes found weaknesses and vulnerabilities

Publishing scan results can pose a security risk, consider using glsr-present in trusted environments only.


Obsolete on Ultimate

If you are already on a GitLab Ultimate subscription, this package is superseded by the GitLab provided visualizations.


Usage options

Installation from PyPI

pip install glsr-present

Jinja2 Version 3.1.2 (or newer) is required and will be installed as an indirect dependency if not installed yet.

Installation in a virtual environment is strongly recommended.

Run through uvx directly

If you already use uv, you can simply run glsr-present through uvx without prior install:

uvx glsr-present

Help message

Output of glsr-present --help:

usage: glsr-present [-h] [--version] [-d | -v | -q]
                    [-b TEMPLATE_NAME | -f TEMPLATE_PATH] [-l] [-n]
                    [-o DESTINATION] [-r DIRECTORY] [-s]

Provide build information and pretty-printed GitLab security reports in a CI
pipeline

options:
  -h, --help            show this help message and exit
  --version             print version and exit
  -l, --list-templates  list available templates and exit
  -n, --dry-run         no action (dry run): do not write any files
  -o DESTINATION, --output-directory DESTINATION
                        write files to directory DESTINATION (default: docs)
  -r DIRECTORY, --reports-path DIRECTORY
                        read reports from DIRECTORY (default:
                        /home/rainer/git/glsr-present)
  -s, --skip-reports    skip reading reports, just provide build information

Logging options:
  control log level (default is WARNING)

  -d, --debug           output all messages (log level DEBUG)
  -v, --verbose         be more verbose (log level INFO)
  -q, --quiet           be more quiet (log level ERROR)

Template option:
  Select a builtin template or one from the file system for the overview
  page

  -b TEMPLATE_NAME, --builtin-template TEMPLATE_NAME
                        use the built-in template TEMPLATE_NAME (default:
                        build-info.md.j2)
  -f TEMPLATE_PATH, --template-file TEMPLATE_PATH
                        use the template from file TEMPLATE_PATH

Further reading

Please see the documentation at https://blackstream-x.gitlab.io/glsr-present for detailed usage information.

If you found a bug or have a feature suggestion, please open an issue here


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

glsr_present-0.3.6.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

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

glsr_present-0.3.6-py3-none-any.whl (16.2 kB view details)

Uploaded Python 3

File details

Details for the file glsr_present-0.3.6.tar.gz.

File metadata

  • Download URL: glsr_present-0.3.6.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for glsr_present-0.3.6.tar.gz
Algorithm Hash digest
SHA256 541785c115e422a4114ad839d4b44003f8dc186bb36062e31d5a01dd3186dd31
MD5 b0fcff49352bd8f5471515fc43ddc922
BLAKE2b-256 10c9d22a52e95bd7c2026828d907e7a4ea64d2129ab052e6a3cd2e45833166d1

See more details on using hashes here.

File details

Details for the file glsr_present-0.3.6-py3-none-any.whl.

File metadata

  • Download URL: glsr_present-0.3.6-py3-none-any.whl
  • Upload date:
  • Size: 16.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for glsr_present-0.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 642ba4e7973f727ce6e4df069c9c498aac47490949b1a108d4db5144606db8a3
MD5 8f612b79eb677357d4341bb9abbb0961
BLAKE2b-256 b7a6f1e38bd18640e9017a5757e46d54adeef3a76ce2e837c498a7c5167b6a5d

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