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.0.tar.gz (10.3 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.0-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: badges_gitlab-2.0.0.tar.gz
  • Upload date:
  • Size: 10.3 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.0.tar.gz
Algorithm Hash digest
SHA256 a5fe0e2f6b91be27f09faf844f047b10550a6432b794570024d6cf6d49a613a5
MD5 43b343b55cfd56b2be0364f6cb76d8bc
BLAKE2b-256 4f05b6ed1d4d17d93e634ad52f3eebe8e1a6e0863cd321c9164f867e3c0b8240

See more details on using hashes here.

File details

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

File metadata

  • Download URL: badges_gitlab-2.0.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 876a898a648237bddd82d6bf2f517e3141206e0a0aa27f54e12ed5ab28ab3866
MD5 1e2531378818435c89e1038759c8ef1a
BLAKE2b-256 a9b665225ddec1bdce548163904aca02b92fd7b38ad75b948cfddba1c36c11d0

See more details on using hashes here.

Release history Release notifications | RSS feed

2.0.1

2 files

This release

2.0.0 This release

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