prometa.git.gitlab package

Subpackages

• prometa.git.gitlab.badges package
  • Subpackages
    • prometa.git.gitlab.badges.python package
      • Submodules
      • prometa.git.gitlab.badges.python.black module
      • prometa.git.gitlab.badges.python.hatch module
      • prometa.git.gitlab.badges.python.isort module
      • prometa.git.gitlab.badges.python.pylint module
      • prometa.git.gitlab.badges.python.pypi module
      • prometa.git.gitlab.badges.python.pypi_downloads module
      • prometa.git.gitlab.badges.python.python module
      • Module contents
  • Submodules
  • prometa.git.gitlab.badges.badge_manager module
    • BadgeManager
      • BadgeManager.NAME
      • BadgeManager.__init__()
      • BadgeManager.create_badge()
      • BadgeManager.delete_badge()
      • BadgeManager.enabled
      • BadgeManager.get_badge_by_name()
      • BadgeManager.gitlab_project
      • BadgeManager.include
      • BadgeManager.manage()
      • BadgeManager.project
      • BadgeManager.update_badge()
      • BadgeManager.urls
  • prometa.git.gitlab.badges.common module
    • get_badge_url()
  • prometa.git.gitlab.badges.latest_release module
    • LatestReleaseBadgeManager
      • LatestReleaseBadgeManager.NAME
      • LatestReleaseBadgeManager.include
      • LatestReleaseBadgeManager.urls
  • prometa.git.gitlab.badges.license module
    • LicenseBadgeManager
      • LicenseBadgeManager.NAME
      • LicenseBadgeManager.include
      • LicenseBadgeManager.urls
  • prometa.git.gitlab.badges.pipeline_status module
    • PipelineStatusBadgeManager
      • PipelineStatusBadgeManager.NAME
      • PipelineStatusBadgeManager.include
      • PipelineStatusBadgeManager.urls
  • prometa.git.gitlab.badges.test_coverage module
    • TestCoverageBadgeManager
      • TestCoverageBadgeManager.NAME
      • TestCoverageBadgeManager.include
      • TestCoverageBadgeManager.urls
  • Module contents
    • BadgeManager
      • BadgeManager.NAME
      • BadgeManager.__init__()
      • BadgeManager.create_badge()
      • BadgeManager.delete_badge()
      • BadgeManager.enabled
      • BadgeManager.get_badge_by_name()
      • BadgeManager.gitlab_project
      • BadgeManager.include
      • BadgeManager.manage()
      • BadgeManager.project
      • BadgeManager.update_badge()
      • BadgeManager.urls
    • GitLabBadgesMixin
      • GitLabBadgesMixin.get_badge_manager()
      • GitLabBadgesMixin.get_markdown_badges()
      • GitLabBadgesMixin.manage_badges()
• prometa.git.gitlab.ci package
  • Subpackages
    • prometa.git.gitlab.ci.python package
      • Submodules
      • prometa.git.gitlab.ci.python.pylint module
      • prometa.git.gitlab.ci.python.register_python_package module
      • Module contents
  • Submodules
  • prometa.git.gitlab.ci.ci_job_manager module
    • CIJobManager
      • CIJobManager.NAME
      • CIJobManager.__init__()
      • CIJobManager.enabled
      • CIJobManager.manage()
  • prometa.git.gitlab.ci.pages module
    • PagesCIJobManager
      • PagesCIJobManager.NAME
      • PagesCIJobManager.manage()
  • prometa.git.gitlab.ci.release_job module
    • ReleaseJobCIJobManager
      • ReleaseJobCIJobManager.NAME
      • ReleaseJobCIJobManager.manage()
  • Module contents
    • CIJobManager
      • CIJobManager.NAME
      • CIJobManager.__init__()
      • CIJobManager.enabled
      • CIJobManager.manage()
    • GitLabCI
      • GitLabCI.__init__()
      • GitLabCI.add_stages()
      • GitLabCI.add_tags()
      • GitLabCI.data
      • GitLabCI.get_ci_job_manager()
      • GitLabCI.load()
      • GitLabCI.manage()
      • GitLabCI.project
• prometa.git.gitlab.hooks package
  • Submodules
  • prometa.git.gitlab.hooks.hook_manager module
    • HookManager
      • HookManager.NAME
      • HookManager.__init__()
      • HookManager.enabled
      • HookManager.gitlab_project
      • HookManager.manage()
      • HookManager.project
  • prometa.git.gitlab.hooks.software_heritage module
    • SoftwareHeritageHookManager
      • SoftwareHeritageHookManager.NAME
      • SoftwareHeritageHookManager.manage()
  • Module contents
    • GitLabHooksMixin
      • GitLabHooksMixin.get_hook_manager()
      • GitLabHooksMixin.manage_hooks()
    • HookManager
      • HookManager.NAME
      • HookManager.__init__()
      • HookManager.enabled
      • HookManager.gitlab_project
      • HookManager.manage()
      • HookManager.project

Submodules

prometa.git.gitlab.api module

Wrapper around python-gitlab functionality.

class prometa.git.gitlab.api.GitLabAPI(host)

Bases: ExitStack, GitLabBadgesMixin, GitLabHooksMixin

Wrapper around GitLab API via python-gitlab.

__init__(host)

Parameters:

host – A GitLabHost instance.

property gitlab

The python-gitlab GitLab instance. It is only be accessible within this class’s context.

property gitlab_config

The gitlab of the project configuration file.

property gitlab_project

The python-gitlab Project instance.

manage()

Update the repository via API calls.

manage_description()

Manage the description. It will be taken from the first Package instance.

manage_merge_method()

Manage the merge method.

manage_protected_branches()

Manage protected branches as per the configuration file.

manage_protected_tags()

Manage protected tags as per the configuration file.

property project

The Project instance or subclass.

prometa.git.gitlab.api.get_access_level(value)

Get the access level from a user-supplied value.

Parameters:

value – A case-insensitive string corresponding to an access level constant in AccessLevel or an integer access level. If the value is None or unrecognized, the maintainer access level is returned.

Returns:

The integer access level.

prometa.git.gitlab.host module

Functionality for GitLab hosts.

class prometa.git.gitlab.host.GitLabHost(project)

Bases: GitHost

Functionality for GitLab hosts.

property gitlab_api

The GitLabAPI instance.

property gitlab_ci

The GitLabCI instance.

property is_used

Check if the configuration indicates that this project uses this host.

Parameters:

project – A Project instance.

Returns:

True if the project is configured to use this host, else False.

property main_branches

The main branches to which to restrict some configurations such as CI jobs via the “only” parameter.

update()

Update the host via metadata files and/or API calls. This should handle CI, hooks, badges, etc.

property urls

A dict of URLs specific to this host.

Module contents

Package stub.