gitea.cli.label.create

create

Create label command.

Functions:

gitea.cli.label.create.create_command

create_command(
    ctx: Context,
    owner: Annotated[
        str,
        Option("--owner", help="Owner of the repository."),
    ],
    name: Annotated[
        str, Option("--name", help="Name of the label.")
    ],
    color: Annotated[
        str,
        Option(
            "--color",
            help="Color of the label in hexadecimal format (e.g. #00aabb).",
        ),
    ],
    repository: Annotated[
        str | None,
        Option(
            "--repository", help=REPOSITORY_REQUIRED_HELP
        ),
    ] = None,
    description: Annotated[
        str | None,
        Option(
            "--description",
            help="Description of the label.",
        ),
    ] = None,
    account_name: Annotated[
        str | None,
        Option(
            "--account-name",
            help="Name of the account to use for authentication.",
        ),
    ] = None,
    token: Annotated[
        str | None,
        Option(
            "--token",
            help="Token for authentication. If not provided, the token from the specified account will be used.",
        ),
    ] = None,
    base_url: Annotated[
        str | None,
        Option(
            "--base-url",
            help="Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.",
        ),
    ] = None,
) -> None

Create a label in a repository.

Parameters:

Name	Type	Description	Default
ctx	Context	The Typer context.	required
owner	Annotated[str, Option('--owner', help='Owner of the repository.')]	The owner of the repository.	required
repository	Annotated[str | None, Option('--repository', help=REPOSITORY_REQUIRED_HELP)]	The name of the repository, which this command requires.	None
name	Annotated[str, Option('--name', help='Name of the label.')]	The name of the label.	required
color	Annotated[str, Option('--color', help='Color of the label in hexadecimal format (e.g. #00aabb).')]	The color of the label in hexadecimal format.	required
description	Annotated[str | None, Option('--description', help='Description of the label.')]	The description of the label.	None
account_name	Annotated[str | None, Option('--account-name', help='Name of the account to use for authentication.')]	Name of the account to use for authentication.	None
token	Annotated[str | None, Option('--token', help='Token for authentication. If not provided, the token from the specified account will be used.')]	Token for authentication.	None
base_url	Annotated[str | None, Option('--base-url', help='Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.')]	Base URL of the Gitea platform.	None

Source code in src/gitea/cli/label/create.py

def create_command(
    ctx: typer.Context,
    owner: Annotated[str, typer.Option("--owner", help="Owner of the repository.")],
    name: Annotated[str, typer.Option("--name", help="Name of the label.")],
    color: Annotated[str, typer.Option("--color", help="Color of the label in hexadecimal format (e.g. #00aabb).")],
    repository: Annotated[str | None, typer.Option("--repository", help=REPOSITORY_REQUIRED_HELP)] = None,
    description: Annotated[
        str | None,
        typer.Option("--description", help="Description of the label."),
    ] = None,
    account_name: Annotated[
        str | None,
        typer.Option(
            "--account-name",
            help="Name of the account to use for authentication.",
        ),
    ] = None,
    token: Annotated[
        str | None,
        typer.Option(
            "--token",
            help="Token for authentication. If not provided, the token from the specified account will be used.",
        ),
    ] = None,
    base_url: Annotated[
        str | None,
        typer.Option(
            "--base-url",
            help="Base URL of the Gitea platform. If not provided, the base URL from the specified account will be used.",
        ),
    ] = None,
) -> None:
    """Create a label in a repository.

    Args:
        ctx: The Typer context.
        owner: The owner of the repository.
        repository: The name of the repository, which this command requires.
        name: The name of the label.
        color: The color of the label in hexadecimal format.
        description: The description of the label.
        account_name: Name of the account to use for authentication.
        token: Token for authentication.
        base_url: Base URL of the Gitea platform.

    """
    from typing import Any  # noqa: PLC0415

    from gitea.cli.utils.api import execute_api_command  # noqa: PLC0415
    from gitea.cli.utils.auth import get_auth_params  # noqa: PLC0415
    from gitea.cli.utils.options import require_repository  # noqa: PLC0415
    from gitea.client.gitea import Gitea  # noqa: PLC0415

    token, base_url = get_auth_params(
        config_path=ctx.obj.get("config_path"),
        account_name=account_name,
        token=token,
        base_url=base_url,
    )

    def api_call() -> tuple[dict[str, Any] | list[dict[str, Any]], dict[str, Any]]:
        """Create label information.

        Returns:
            A tuple containing the label data and metadata.

        """
        target_repository = require_repository(repository, command="gitea-cli label create")

        with Gitea(token=token, base_url=base_url) as client:
            return client.label.create_label(
                owner=owner,
                repository=target_repository,
                name=name,
                color=color,
                description=description,
            )

    execute_api_command(api_call=api_call, base_url=base_url, command_name="gitea-cli label create")