prometa.git.gitlab.badges package

Subpackages

• prometa.git.gitlab.badges.python package
  • Submodules
  • prometa.git.gitlab.badges.python.black module
    • BlackBadgeManager
      • BlackBadgeManager.NAME
      • BlackBadgeManager.urls
  • prometa.git.gitlab.badges.python.hatch module
    • HatchBadgeManager
      • HatchBadgeManager.NAME
      • HatchBadgeManager.include
      • HatchBadgeManager.urls
  • prometa.git.gitlab.badges.python.isort module
    • IsortBadgeManager
      • IsortBadgeManager.NAME
      • IsortBadgeManager.urls
  • prometa.git.gitlab.badges.python.pylint module
    • PylintBadgeManager
      • PylintBadgeManager.NAME
      • PylintBadgeManager.urls
  • prometa.git.gitlab.badges.python.pypi module
    • PyPIBadgeManager
      • PyPIBadgeManager.NAME
      • PyPIBadgeManager.include
      • PyPIBadgeManager.urls
  • prometa.git.gitlab.badges.python.pypi_downloads module
    • PyPIDownloadsBadgeManager
      • PyPIDownloadsBadgeManager.NAME
      • PyPIDownloadsBadgeManager.include
      • PyPIDownloadsBadgeManager.urls
  • prometa.git.gitlab.badges.python.python module
    • PythonBadgeManager
      • PythonBadgeManager.include
      • PythonBadgeManager.package
    • ToggledPythonBadgeManager
      • ToggledPythonBadgeManager.include
      • ToggledPythonBadgeManager.prometa_badge_list
  • Module contents

Submodules

prometa.git.gitlab.badges.badge_manager module

Base class for each badge manager.

class prometa.git.gitlab.badges.badge_manager.BadgeManager(gitlab_api)

Bases: Registrable

Registrable base class for each badge manager.

NAME = None

__init__(gitlab_api)

Parameters:

gitlab_api – A GitLabApi instance.

create_badge(name, link_url, image_url)

Create a new badge.

Parameters:

• name – The badge name.

• link_url – The badge link URL.

• image_url – The badge image URL.

static delete_badge(badge)

Delete a badge.

Parameters:

badge – A Badge instance.

property enabled

The badge’s name is in the gitlab.enabled_badges list in the configuration file.

get_badge_by_name(name)

Get a badge by name.

Parameters:

name – The name of the badge.

Returns:

The Badge instance, or None of not badge of the given name was found.

property gitlab_project

The python-gitlab Project instance.

property include

True if the condition for including this badge is met, else False. The configuration file determines of the badge is managed whereas this property determines if the badge is added or removed when the badge is managed.

manage()

Manage the badge.

property project

The Project instance.

static update_badge(badge, link_url, image_url)

Update a badge if necessary.

Parameters:

• badge – A Badge instance.

• link_url – The badge link URL.

• image_url – The badge image URL.

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.common module

Common functions for badge management.

prometa.git.gitlab.badges.common.get_badge_url(label, message, color, **query_params)

Get a URL to an SVG image of a custom badge generated by the img.shields.io website.

Parameters:

• label – The text on the left side of the badge.

• message – The text on the right side of the badge.

• color – The hexadecimal color code for the background of the message.

• query_params – Additional query parameters for the img.shields.io URL.

Returns:

The image URL as a string.

prometa.git.gitlab.badges.latest_release module

Latest release badge.

class prometa.git.gitlab.badges.latest_release.LatestReleaseBadgeManager(gitlab_api)

Bases: BadgeManager

The latest tagged release on the project’s GitLab host. This uses the built-in GitLab release badge.

NAME = 'Latest Release'

property include

The badge’s name is in the gitlab.enabled_badges list in the configuration file.

AND

The project’s GitLab CI file contains a release job.

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.license module

Project license.

class prometa.git.gitlab.badges.license.LicenseBadgeManager(gitlab_api)

Bases: BadgeManager

The project’s license name, as recognized by SPDX.

NAME = 'License'

property include

The badge’s name is in the gitlab.enabled_badges list in the configuration file.

AND

The project has a recognized SPDX license.

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.pipeline_status module

Pipeline status badge.

class prometa.git.gitlab.badges.pipeline_status.PipelineStatusBadgeManager(gitlab_api)

Bases: BadgeManager

The current pipeline status on the project’s GitLab host. This uses the built-in GitLab pipeline badge.

NAME = 'Pipeline Status'

property include

The badge’s name is in the gitlab.enabled_badges list in the configuration file.

AND

The GitLab CI configuration file exists.

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.test_coverage module

Test coverage badge.

class prometa.git.gitlab.badges.test_coverage.TestCoverageBadgeManager(gitlab_api)

Bases: BadgeManager

Display the currently configured test coverage results.

NAME = 'Test Coverage'

property include

The badge’s name is in the gitlab.enabled_badges list in the configuration file.

AND

The project’s GitLab CI file contains test jobs with coverage fields.

property urls

The link and image URLs for the badge.

Module contents

Manage project badges on GitLab.

class prometa.git.gitlab.badges.BadgeManager(gitlab_api)

Bases: Registrable

Registrable base class for each badge manager.

NAME = None

__init__(gitlab_api)

Parameters:

gitlab_api – A GitLabApi instance.

create_badge(name, link_url, image_url)

Create a new badge.

Parameters:

• name – The badge name.

• link_url – The badge link URL.

• image_url – The badge image URL.

static delete_badge(badge)

Delete a badge.

Parameters:

badge – A Badge instance.

property enabled

The badge’s name is in the gitlab.enabled_badges list in the configuration file.

get_badge_by_name(name)

Get a badge by name.

Parameters:

name – The name of the badge.

Returns:

The Badge instance, or None of not badge of the given name was found.

property gitlab_project

The python-gitlab Project instance.

property include

True if the condition for including this badge is met, else False. The configuration file determines of the badge is managed whereas this property determines if the badge is added or removed when the badge is managed.

manage()

Manage the badge.

property project

The Project instance.

static update_badge(badge, link_url, image_url)

Update a badge if necessary.

Parameters:

• badge – A Badge instance.

• link_url – The badge link URL.

• image_url – The badge image URL.

property urls

The link and image URLs for the badge.

class prometa.git.gitlab.badges.GitLabBadgesMixin

Bases: object

Mixin to handle badges in GitLabApi class.

get_badge_manager(name)

Get an instance of the named BadgeManager subclass.

get_markdown_badges()

Get an iterable over all badges as Markdown image links.

manage_badges()

Add or remove badges depending on the current repository configuration.