prometa.git.gitlab.badges.python package

Submodules

prometa.git.gitlab.badges.python.black module

Black code-style badge.

class prometa.git.gitlab.badges.python.black.BlackBadgeManager(gitlab_api)

Bases: ToggledPythonBadgeManager

The Python package uses Black for code formatting.

NAME = 'Black'

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.python.hatch module

Hatch and Hatchling build system.

class prometa.git.gitlab.badges.python.hatch.HatchBadgeManager(gitlab_api)

Bases: PythonBadgeManager

The Python package uses the Hatch build system.

NAME = 'Hatch'

property include

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

AND

The project includes a Python package.

AND

The package is configured to use Hatch via pyproject.toml.

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.python.isort module

isort import sorting badge.

class prometa.git.gitlab.badges.python.isort.IsortBadgeManager(gitlab_api)

Bases: ToggledPythonBadgeManager

The Python package sorts imports with isort.

NAME = 'isort'

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.python.pylint module

Display the Pylint score.

class prometa.git.gitlab.badges.python.pylint.PylintBadgeManager(gitlab_api)

Bases: PythonBadgeManager

Display the Pylint score.

NAME = 'Pylint'

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.python.pypi module

PyPI package.

class prometa.git.gitlab.badges.python.pypi.PyPIBadgeManager(gitlab_api)

Bases: PythonBadgeManager

The Python project’s name on PyPI.

NAME = 'PyPI'

property include

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

AND

The project includes a Python package.

AND

The package exists on PyPI.

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.python.pypi_downloads module

PyPI downloads.

class prometa.git.gitlab.badges.python.pypi_downloads.PyPIDownloadsBadgeManager(gitlab_api)

Bases: PythonBadgeManager

Estimated number of downloads from PyPI.

NAME = 'PyPI Downloads'

property include

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

AND

The project includes a Python package.

AND

The package exists on PyPI.

property urls

The link and image URLs for the badge.

prometa.git.gitlab.badges.python.python module

Base class for Python badges.

class prometa.git.gitlab.badges.python.python.PythonBadgeManager(gitlab_api)

Bases: BadgeManager

Base class for Python badges.

property include

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

AND

The project includes a Python package.

property package

The Python Package instance, or None if the project does not contain a Python package.

class prometa.git.gitlab.badges.python.python.ToggledPythonBadgeManager(gitlab_api)

Bases: PythonBadgeManager

Base class for Python badges that are toggled by adding their names to the tool.prometa.enabled_badges list in pyproject.toml. In general these are badges for which no easily verifiable condition exists.

property include

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

AND

The project includes a Python package.

AND

NAME is included in a list named enabled_badges in the [tool.prometa] section of the project’s pyproject.toml file, e.g. enabled_badges = ["NAME"].

property prometa_badge_list

The list of enabled badges in the pyproject.toml’s tool.prometa section.

Module contents

Package stub.