Skip to main content

Badges Gitlab

Pypi Version Status Python Version License Coverage Pipeline Documentation Status

This project was created to generate badges for Gitlab in CI jobs, mainly for private repositories where other common methods are not available (direct API Calls, shields.io, etc...).

By default, Gitlab supports only two types of badges: pipeline and test coverage.

These badges are better detailed at: Gitlab Project Badges.

Installation

You can install this package from pypi using pip.

$ pip install badges-gitlab

General Usage

usage: badges-gitlab [-h] [-p PATH] [-t TOKEN] [--junit-xml FILE_PATH] [-s LABEL MESSAGE COLOR] 
[-lb URLS [URLS ...]] [-V]

Generate Gitlab Badges using JSON files and API requests. Program version v0.0.0.

optional arguments:
  -h, --help            show this help message and exit
  -p TEXT, --path TEXT  path where json and badges files will be generated/located (default: ./public/badges/)
  -t TEXT, --token TEXT specify the private-token in command line (default: ${PRIVATE_TOKEN})
  --junit-xml TEXT      specifies the path of a JUnit XML file for parsing the test results
  -s LABEL MESSAGE COLOR, --static-badges LABEL MESSAGE COLOR
                        specify static badges in command line using lists
 -lb URLS [URLS ...], --link-badges URLS [URLS ...]
                        specify shields.io urls to download badges
  -V, --version         returns the package version

Author

Felipe Pinheiro Silva

Contributors

Benjamin Maréchal (irmo322)

Further Documentation

Slowly moving documentation to ReadTheDocs.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

badges_gitlab-2.0.1.tar.gz (10.2 kB view details)

Uploaded Source

Built Distribution

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

badges_gitlab-2.0.1-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

Details for the file badges_gitlab-2.0.1.tar.gz.

File metadata

  • Download URL: badges_gitlab-2.0.1.tar.gz
  • Upload date:
  • Size: 10.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for badges_gitlab-2.0.1.tar.gz
Algorithm Hash digest
SHA256 54b8b6768d9e9fbd6d4e93bf1dcc59c14e3c81498571bc9c6b51afbed76c8269
MD5 c6304b1deb2ba8184f1e36e9b00c91ee
BLAKE2b-256 7333fd9a2218f3084abda39e347a9e057b11c0891990670f23215fdf128ffb45

See more details on using hashes here.

File details

Details for the file badges_gitlab-2.0.1-py3-none-any.whl.

File metadata

  • Download URL: badges_gitlab-2.0.1-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.12.13

File hashes

Hashes for badges_gitlab-2.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3f5ea469bf7edf3cb985db570f98ae311e71ae7e19bc683f268f1af7359b1e43
MD5 dd4f200da7c194db5f72b243f97f62fb
BLAKE2b-256 3593c09b67a0adc5d777c66ec5a08f21c3932dd05db1bdf1711f92a254581ed0

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

2.0.1 This release

2 files

2.0.0

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

0.8.4

2 files

0.8.3

2 files

0.8.2

2 files

0.8.1

2 files

0.8.0

2 files

0.7.0

2 files

0.6.0

2 files

0.5.1

2 files

0.5.0

2 files

0.4.0

2 files

0.3.0

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page