gitea.cli.project.edit

edit

Edit project command.

Functions:

gitea.cli.project.edit.edit_command

edit_command(
    ctx: Context,
    owner: Annotated[
        str,
        Option("--owner", help="Owner of the repository."),
    ],
    project_id: Annotated[
        int,
        Option("--project-id", help="ID of the project."),
    ],
    title: Annotated[
        str | None,
        Option("--title", help="Title of the project."),
    ] = None,
    description: Annotated[
        str | None,
        Option(
            "--description",
            help="Description of the project.",
        ),
    ] = None,
    card_type: Annotated[
        str | None,
        Option(
            "--card-type",
            help="Card type of the project (text_only, images_and_text).",
        ),
    ] = None,
    state: Annotated[
        Literal["open", "closed"] | None,
        Option("--state", help="State of the project."),
    ] = None,
    repository: Annotated[
        str | None,
        Option(
            "--repository",
            help="Name of the repository. Omit for organization projects.",
        ),
    ] = 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

Edit a project 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='Name of the repository. Omit for organization projects.')]	The name of the repository, or None for organization projects.	None
project_id	Annotated[int, Option('--project-id', help='ID of the project.')]	The ID of the project.	required
title	Annotated[str | None, Option('--title', help='Title of the project.')]	The title of the project.	None
description	Annotated[str | None, Option('--description', help='Description of the project.')]	The description of the project.	None
card_type	Annotated[str | None, Option('--card-type', help='Card type of the project (text_only, images_and_text).')]	The card type of the project.	None
state	Annotated[Literal['open', 'closed'] | None, Option('--state', help='State of the project.')]	The state of the project.	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/project/edit.py

def edit_command(
    ctx: typer.Context,
    owner: Annotated[str, typer.Option("--owner", help="Owner of the repository.")],
    project_id: Annotated[int, typer.Option("--project-id", help="ID of the project.")],
    title: Annotated[
        str | None,
        typer.Option("--title", help="Title of the project."),
    ] = None,
    description: Annotated[
        str | None,
        typer.Option("--description", help="Description of the project."),
    ] = None,
    card_type: Annotated[
        str | None,
        typer.Option("--card-type", help="Card type of the project (text_only, images_and_text)."),
    ] = None,
    state: Annotated[
        Literal["open", "closed"] | None,
        typer.Option("--state", help="State of the project."),
    ] = None,
    repository: Annotated[
        str | None,
        typer.Option("--repository", help="Name of the repository. Omit for organization projects."),
    ] = 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:
    """Edit a project in a repository.

    Args:
        ctx: The Typer context.
        owner: The owner of the repository.
        repository: The name of the repository, or None for organization projects.
        project_id: The ID of the project.
        title: The title of the project.
        description: The description of the project.
        card_type: The card type of the project.
        state: The state of the project.
        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.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]]:
        """Edit project information.

        Returns:
            A tuple containing the project data and metadata.

        """
        with Gitea(token=token, base_url=base_url) as client:
            return client.project.edit_project(
                owner=owner,
                repository=repository,
                project_id=project_id,
                title=title,
                description=description,
                card_type=card_type,
                state=state,
            )

    execute_api_command(api_call=api_call, base_url=base_url, command_name="gitea-cli project edit")