gitea.cli.organization.list

list

List organizations command.

Functions:

gitea.cli.organization.list.list_command

list_command(
    ctx: Context,
    username: Annotated[
        str | None,
        Option(
            "--username",
            help="Account whose organizations are listed. Omit for the authenticated account.",
        ),
    ] = None,
    page: Annotated[
        int | None,
        Option(
            "--page", help="The page number for pagination."
        ),
    ] = None,
    limit: Annotated[
        int | None,
        Option(
            "--limit",
            help="The number of organizations per page.",
        ),
    ] = 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

List organizations.

Parameters:

Name	Type	Description	Default
ctx	Context	The Typer context.	required
username	Annotated[str | None, Option('--username', help='Account whose organizations are listed. Omit for the authenticated account.')]	The account whose organizations are listed, or None for the authenticated account.	None
page	Annotated[int | None, Option('--page', help='The page number for pagination.')]	The page number for pagination.	None
limit	Annotated[int | None, Option('--limit', help='The number of organizations per page.')]	The number of organizations per page.	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/organization/list.py

def list_command(
    ctx: typer.Context,
    username: Annotated[
        str | None,
        typer.Option(
            "--username",
            help="Account whose organizations are listed. Omit for the authenticated account.",
        ),
    ] = None,
    page: Annotated[
        int | None,
        typer.Option("--page", help="The page number for pagination."),
    ] = None,
    limit: Annotated[
        int | None,
        typer.Option("--limit", help="The number of organizations per page."),
    ] = 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:
    """List organizations.

    Args:
        ctx: The Typer context.
        username: The account whose organizations are listed, or None for the authenticated account.
        page: The page number for pagination.
        limit: The number of organizations per page.
        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]]:
        """List organization information.

        Returns:
            A tuple containing the organization data and metadata.

        """
        with Gitea(token=token, base_url=base_url) as client:
            return client.organization.list_organizations(
                username=username,
                page=page,
                limit=limit,
            )

    execute_api_command(api_call=api_call, base_url=base_url, command_name="gitea-cli org list")