Skip to content

gitea.client.base

base

Base client class for Gitea API interactions.

Classes

gitea.client.base.Client

Client(token: str | None, base_url: str)

Abstract base class for Gitea clients.

Construct the base client.

Parameters:

Name Type Description Default
token str | None

The API token for authentication.

required
base_url str

The base URL of the Gitea instance.

required
Source code in src/gitea/client/base.py
def __init__(self, token: str | None, base_url: str) -> None:
    """Construct the base client.

    Args:
        token: The API token for authentication.
        base_url: The base URL of the Gitea instance.

    """
    self.token = token
    self.base_url = base_url.rstrip("/")
    self.headers: dict[str, Any] = {}
    if self.token:
        self.headers["Authorization"] = f"token {self.token}"
Attributes
gitea.client.base.Client.api_url property
api_url: str

Return the base API URL.

Returns:

Name Type Description
str str

The base API URL.