python-gitea 0.2.0__tar.gz → 0.3.0__tar.gz

{python_gitea-0.2.0 → python_gitea-0.3.0}/.pre-commit-config.yaml

@@ -13,7 +13,7 @@ ci:
 
 repos:
   - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
-    rev: v9.23.0
+    rev: v9.24.0
     hooks:
       - id: commitlint
         stages: [commit-msg]
@@ -50,14 +50,14 @@ repos:
         stages: [pre-commit]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.11
+    rev: v0.14.13
     hooks:
       - id: ruff
         args: [--fix, --config=pyproject.toml]
         stages: [pre-commit]
 
   - repo: https://github.com/psf/black-pre-commit-mirror
-    rev: 25.12.0 # Matches pyproject.toml
+    rev: 26.1.0 # Matches pyproject.toml
     hooks:
       - id: black
         args: [--config=pyproject.toml]
@@ -118,7 +118,7 @@ repos:
         stages: [pre-commit]
 
   - repo: https://github.com/PyCQA/bandit
-    rev: "1.9.2"
+    rev: "1.9.3"
     hooks:
       - id: bandit
         args: ["-c", "pyproject.toml"]

{python_gitea-0.2.0 → python_gitea-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-gitea
-Version: 0.2.0
+Version: 0.3.0
 Summary: A Python package for interacting with the Gitea API, offering a simple interface to access repositories, users, organizations, issues, and more for automation and data management.
 Project-URL: Documentation, https://isaac-cf-wong.github.io/python-gitea
 Project-URL: Source, https://github.com/isaac-cf-wong/python-gitea
@@ -34,8 +34,8 @@ Requires-Dist: mkdocs-material; extra == 'docs'
 Requires-Dist: mkdocs-section-index; extra == 'docs'
 Requires-Dist: mkdocstrings[python]; extra == 'docs'
 Provides-Extra: test
-Requires-Dist: bandit[toml]==1.9.2; extra == 'test'
-Requires-Dist: black==25.12.0; extra == 'test'
+Requires-Dist: bandit[toml]==1.9.3; extra == 'test'
+Requires-Dist: black==26.1.0; extra == 'test'
 Requires-Dist: check-manifest==0.51; extra == 'test'
 Requires-Dist: flake8; extra == 'test'
 Requires-Dist: flake8-bugbear==25.11.29; extra == 'test'

{python_gitea-0.2.0 → python_gitea-0.3.0}/mkdocs.yml

@@ -76,12 +76,16 @@ nav:
           - Client:
               - Overview: reference/gitea/client/index.md
               - Base: reference/gitea/client/base.md
-              - AsyncGitea: reference/gitea/client/async_gitea.md
+              - Async Gitea: reference/gitea/client/async_gitea.md
               - Gitea: reference/gitea/client/gitea.md
           - Resource:
               - Overview: reference/gitea/resource/index.md
               - Resource: reference/gitea/resource/resource.md
-              - AsyncResource: reference/gitea/resource/async_resource.md
+              - Async Resource: reference/gitea/resource/async_resource.md
+          - Issue:
+              - Overview: reference/gitea/issue/index.md
+              - Issue: reference/gitea/issue/issue.md
+              - Async Issue: reference/gitea/issue/async_issue.md
           - User:
               - Overview: reference/gitea/user/index.md
               - User: reference/gitea/user/user.md

{python_gitea-0.2.0 → python_gitea-0.3.0}/pyproject.toml

@@ -26,8 +26,8 @@ dependencies = [
 
 [project.optional-dependencies]
 test = [
-    "bandit[toml]==1.9.2",
-    "black==25.12.0",
+    "bandit[toml]==1.9.3",
+    "black==26.1.0",
     "check-manifest==0.51",
     "flake8-bugbear==25.11.29",
     "flake8-docstrings",
@@ -179,6 +179,8 @@ lint.extend-select = [
     "PL",  # Add pylint rules for fuller coverage
     "SIM",  # Similarities
     "T10",  # Debugger statements
+    "DOC", # Docstring
+    "D",   # Doc style
 ]
 lint.ignore = [
     "E501", # Line length (handled by formatter)

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/__init__.py

@@ -1,6 +1,4 @@
-"""
-Top-level package for python-gitea.
-"""
+"""Top-level package for python-gitea."""
 
 from __future__ import annotations
 

python_gitea-0.3.0/src/gitea/cli/__init__.py

@@ -0,0 +1 @@
+"""Command line interface for Gitea."""

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/cli/main.py

@@ -33,6 +33,7 @@ def setup_logging(level: LoggingLevel = LoggingLevel.INFO) -> None:
 
     Args:
         level: Logging level.
+
     """
     import logging  # noqa: PLC0415
 
@@ -97,13 +98,16 @@ def main(  # noqa: PLR0913
         typer.Option("--verbose", "-v", help="Set verbosity level."),
     ] = LoggingLevel.INFO,
 ) -> None:
-    """Main entry point for the CLI application.
+    """Enter the CLI application.
 
     Args:
         ctx: Typer context.
+        output: Output file name.
         token: Gitea API token.
         base_url: Base URL of the Gitea instance.
+        timeout: Timeout for API requests in seconds.
         verbose: Verbosity level for logging.
+
     """
     setup_logging(verbose)
     ctx.obj = {

python_gitea-0.3.0/src/gitea/cli/user/__init__.py

@@ -0,0 +1 @@
+"""User module for CLI commands."""

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/cli/user/delete_user_level_runner.py

@@ -14,7 +14,9 @@ def delete_user_level_runner_command(
     """Delete a user-level runner for the authenticated user.
 
     Args:
+        ctx: The Typer context.
         runner_id: The ID of the runner to delete.
+
     """
     from typing import Any  # noqa: PLC0415
 
@@ -26,11 +28,11 @@ def delete_user_level_runner_command(
     timeout: int = ctx.obj.get("timeout")
 
     def api_call() -> dict[str, Any] | None:
-        """
-        API call to delete a user-level runner.
+        """Delete a user-level runner.
 
         Returns:
             A dictionary containing the result of the deletion.
+
         """
         with gitea.client.gitea.Gitea(token=token, base_url=base_url) as client:
             return client.user.delete_user_level_runner(runner_id=runner_id, timeout=timeout)

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/cli/user/get_registration_token.py

@@ -19,11 +19,11 @@ def get_registration_token_command(
     timeout: int = ctx.obj.get("timeout")
 
     def api_call() -> dict[str, Any] | None:
-        """
-        API call to get the registration token.
+        """Get registration token.
 
         Returns:
             A dictionary containing the registration token.
+
         """
         with gitea.client.gitea.Gitea(token=token, base_url=base_url) as client:
             return client.user.get_registration_token(timeout=timeout)

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/cli/user/get_user.py

@@ -16,7 +16,9 @@ def get_user_command(
     """Get user information.
 
     Args:
+        ctx: The Typer context.
         username: The username of the user to retrieve. If None, retrieves the authenticated user.
+
     """
     from typing import Any  # noqa: PLC0415
 
@@ -28,10 +30,11 @@ def get_user_command(
     timeout: int = ctx.obj.get("timeout")
 
     def api_call() -> dict[str, Any] | None:
-        """API call to get user information.
+        """Get user information.
 
         Returns:
             The user information as a dictionary.
+
         """
         with gitea.client.gitea.Gitea(token=token, base_url=base_url) as client:
             return client.user.get_user(username=username, timeout=timeout)

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/cli/user/get_user_level_runners.py

@@ -22,11 +22,11 @@ def get_user_level_runners_command(
     timeout: int = ctx.obj.get("timeout")
 
     def api_call() -> dict[str, Any] | None:
-        """
-        API call to get user-level runners.
+        """Get user-level runners.
 
         Returns:
             A dictionary containing the user-level runners.
+
         """
         with gitea.client.gitea.Gitea(token=token, base_url=base_url) as client:
             return client.user.get_user_level_runners(runner_id=runner_id, timeout=timeout)

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/cli/user/get_workflow_jobs.py

@@ -22,9 +22,11 @@ def get_workflow_jobs_command(
     """Get workflow jobs for the authenticated user filtered by status.
 
     Args:
+        ctx: The Typer context.
         status: The status to filter workflow jobs by. Options: pending, queued, in_progress, failure, success, skipped.
         page: The page number for pagination.
         limit: The number of items per page for pagination.
+
     """
     from typing import Any  # noqa: PLC0415
 
@@ -36,10 +38,11 @@ def get_workflow_jobs_command(
     timeout: int = ctx.obj.get("timeout")
 
     def api_call() -> dict[str, Any] | None:
-        """API call to get workflow jobs.
+        """Get workflow jobs.
 
         Returns:
             A dictionary containing the workflow jobs with the specified status.
+
         """
         with gitea.client.gitea.Gitea(token=token, base_url=base_url) as client:
             return client.user.get_workflow_jobs(status=status, page=page, limit=limit, timeout=timeout)

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/cli/user/get_workflow_runs.py

@@ -26,6 +26,7 @@ def get_workflow_runs_command(  # noqa: PLR0913
     """Get workflow runs for the authenticated user filtered by various parameters.
 
     Args:
+        ctx: The Typer context.
         event: The event that triggered the workflow run.
         branch: The branch name to filter workflow runs.
         status: The status to filter workflow jobs by. Options: pending, queued, in_progress, failure, success, skipped.
@@ -33,6 +34,7 @@ def get_workflow_runs_command(  # noqa: PLR0913
         head_sha: The head SHA to filter workflow runs.
         page: The page number for pagination.
         limit: The number of items per page for pagination.
+
     """
     from typing import Any  # noqa: PLC0415
 
@@ -44,10 +46,11 @@ def get_workflow_runs_command(  # noqa: PLR0913
     timeout: int = ctx.obj.get("timeout")
 
     def api_call() -> dict[str, Any] | None:
-        """API call to get workflow runs.
+        """Get workflow runs.
 
         Returns:
             A dictionary containing the workflow runs.
+
         """
         with gitea.client.gitea.Gitea(token=token, base_url=base_url) as client:
             return client.user.get_workflow_runs(

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/cli/utils.py

@@ -22,6 +22,7 @@ def execute_api_command(
         ctx: Typer context containing token, base_url, and output.
         api_call: Callable that executes the API call and returns the result.
         command_name: Name of the command for error messages.
+
     """
     output: Path | None = ctx.obj.get("output")
     console = Console()

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/client/async_gitea.py

@@ -18,6 +18,7 @@ class AsyncGitea(Client):  # pylint: disable=too-few-public-methods
         Args:
             token: The API token for authentication.
             base_url: The base URL of the Gitea instance.
+
         """
         super().__init__(token=token, base_url=base_url)
         self.session: ClientSession | None = None
@@ -27,6 +28,7 @@ class AsyncGitea(Client):  # pylint: disable=too-few-public-methods
 
         Returns:
             A string representing the AsyncGitea client.
+
         """
         return f"AsyncGitea Client(base_url={self.base_url})"
 
@@ -35,6 +37,7 @@ class AsyncGitea(Client):  # pylint: disable=too-few-public-methods
 
         Returns:
             The AsyncGitea client instance.
+
         """
         if self.session is not None and not self.session.closed:
             raise RuntimeError("AsyncGitea session already open; do not re-enter context manager.")
@@ -48,6 +51,7 @@ class AsyncGitea(Client):  # pylint: disable=too-few-public-methods
             exc_type: The exception type.
             exc_val: The exception value.
             exc_tb: The traceback.
+
         """
         if self.session:
             await self.session.close()
@@ -62,6 +66,7 @@ class AsyncGitea(Client):  # pylint: disable=too-few-public-methods
 
         Returns:
             The aiohttp ClientSession instance.
+
         """
         return ClientSession(headers=headers, **kwargs)
 
@@ -79,6 +84,7 @@ class AsyncGitea(Client):  # pylint: disable=too-few-public-methods
 
         Returns:
             The aiohttp ClientResponse object.
+
         """
         if self.session is None:
             raise RuntimeError(

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/client/base.py

@@ -14,6 +14,7 @@ class Client:  # pylint: disable=too-few-public-methods
         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("/")
@@ -27,6 +28,7 @@ class Client:  # pylint: disable=too-few-public-methods
 
         Returns:
             str: The base API URL.
+
         """
         return f"{self.base_url}/api/v1"
 
@@ -38,5 +40,6 @@ class Client:  # pylint: disable=too-few-public-methods
 
         Returns:
             str: The full URL.
+
         """
         return f"{self.api_url}/{endpoint.lstrip('/')}"

{python_gitea-0.2.0 → python_gitea-0.3.0}/src/gitea/client/gitea.py

@@ -20,6 +20,7 @@ class Gitea(Client):  # pylint: disable=too-few-public-methods
         Args:
             token: The API token for authentication.
             base_url: The base URL of the Gitea instance.
+
         """
         super().__init__(token=token, base_url=base_url)
         self.session: requests.Session | None = None
@@ -30,6 +31,7 @@ class Gitea(Client):  # pylint: disable=too-few-public-methods
 
         Returns:
             A string representing the Gitea client.
+
         """
         return f"Gitea Client(base_url={self.base_url})"
 
@@ -38,6 +40,7 @@ class Gitea(Client):  # pylint: disable=too-few-public-methods
 
         Returns:
             The Gitea client instance.
+
         """
         if self.session is not None:
             raise RuntimeError("Gitea session already open; do not re-enter context manager.")
@@ -51,6 +54,7 @@ class Gitea(Client):  # pylint: disable=too-few-public-methods
             exc_type: The exception type.
             exc_val: The exception value.
             exc_tb: The traceback.
+
         """
         if self.session:
             self.session.close()
@@ -70,6 +74,7 @@ class Gitea(Client):  # pylint: disable=too-few-public-methods
 
         Returns:
             The HTTP response object.
+
         """
         if self.session is None:
             raise RuntimeError(

python_gitea-0.3.0/src/gitea/issue/__init__.py

@@ -0,0 +1,8 @@
+"""Gitea Issue resource."""
+
+from __future__ import annotations
+
+from gitea.issue.async_issue import AsyncIssue
+from gitea.issue.issue import Issue
+
+__all__ = ["AsyncIssue", "Issue"]

python_gitea-0.3.0/src/gitea/issue/async_issue.py

@@ -0,0 +1,277 @@
+"""Asynchronous Gitea Issue resource."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any, Literal, cast
+
+from aiohttp import ClientResponse
+
+from gitea.issue.base import BaseIssue
+from gitea.resource.async_resource import AsyncResource
+from gitea.utils.response import process_async_response
+
+
+class AsyncIssue(BaseIssue, AsyncResource):
+    """Asynchronous Gitea Issue resource."""
+
+    async def _list_issues(  # noqa: PLR0913
+        self,
+        owner: str,
+        repository: str,
+        state: Literal["closed", "open", "all"] | None = None,
+        labels: list[str] | None = None,
+        search_string: str | None = None,
+        issue_type: Literal["issues", "pulls"] | None = None,
+        milestones: list[str] | list[int] | None = None,
+        since: datetime | None = None,
+        before: datetime | None = None,
+        created_by: str | None = None,
+        assigned_by: str | None = None,
+        mentioned_by: str | None = None,
+        page: int | None = None,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> ClientResponse:
+        """List issues in a repository.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            state: Filter issues by state.
+            labels: Filter issues by labels.
+            search_string: Filter issues by search string.
+            issue_type: Filter by issue type.
+            milestones: Filter issues by milestones.
+            since: Filter issues updated since this time.
+            before: Filter issues updated before this time.
+            created_by: Filter issues created by this user.
+            assigned_by: Filter issues assigned to this user.
+            mentioned_by: Filter issues mentioning this user.
+            page: The page number for pagination.
+            limit: The number of issues per page.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response object.
+
+        """
+        endpoint, params = self._list_issues_helper(
+            owner=owner,
+            repository=repository,
+            state=state,
+            labels=labels,
+            search_string=search_string,
+            issue_type=issue_type,
+            milestones=milestones,
+            since=since,
+            before=before,
+            created_by=created_by,
+            assigned_by=assigned_by,
+            mentioned_by=mentioned_by,
+            page=page,
+            limit=limit,
+        )
+        return await self._get(endpoint=endpoint, params=params, **kwargs)
+
+    async def list_issues(  # noqa: PLR0913
+        self,
+        owner: str,
+        repository: str,
+        state: Literal["closed", "open", "all"] | None = None,
+        labels: list[str] | None = None,
+        search_string: str | None = None,
+        issue_type: Literal["issues", "pulls"] | None = None,
+        milestones: list[str] | list[int] | None = None,
+        since: datetime | None = None,
+        before: datetime | None = None,
+        created_by: str | None = None,
+        assigned_by: str | None = None,
+        mentioned_by: str | None = None,
+        page: int | None = None,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> tuple[list[dict[str, Any]], int]:
+        """List issues in a repository.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            state: Filter issues by state.
+            labels: Filter issues by labels.
+            search_string: Filter issues by search string.
+            issue_type: Filter by issue type.
+            milestones: Filter issues by milestones.
+            since: Filter issues updated since this time.
+            before: Filter issues updated before this time.
+            created_by: Filter issues created by this user.
+            assigned_by: Filter issues assigned to this user.
+            mentioned_by: Filter issues mentioning this user.
+            page: The page number for pagination.
+            limit: The number of issues per page.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the list of issues as a list of dictionaries and the status code.
+
+        """
+        response = await self._list_issues(
+            owner=owner,
+            repository=repository,
+            state=state,
+            labels=labels,
+            search_string=search_string,
+            issue_type=issue_type,
+            milestones=milestones,
+            since=since,
+            before=before,
+            created_by=created_by,
+            assigned_by=assigned_by,
+            mentioned_by=mentioned_by,
+            page=page,
+            limit=limit,
+            **kwargs,
+        )
+        data, status_code = await process_async_response(response)
+        return cast(list[dict[str, Any]], data), status_code
+
+    async def _get_issue(self, owner: str, repository: str, index: int, **kwargs: Any) -> ClientResponse:
+        """Get a single issue by its index.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            index: The index of the issue.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response object.
+
+        """
+        endpoint = self._get_issue_helper(owner=owner, repository=repository, index=index)
+        return await self._get(endpoint=endpoint, **kwargs)
+
+    async def get_issue(self, owner: str, repository: str, index: int, **kwargs: Any) -> tuple[dict[str, Any], int]:
+        """Get a single issue by its index.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            index: The index of the issue.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the issue as a dictionary and the status code.
+
+        """
+        response = await self._get_issue(owner=owner, repository=repository, index=index, **kwargs)
+        data, status_code = await process_async_response(response)
+        return cast(dict[str, Any], data), status_code
+
+    async def _edit_issue(  # noqa: PLR0913
+        self,
+        owner: str,
+        repository: str,
+        index: int,
+        assignee: str | None = None,
+        assignees: list[str] | None = None,
+        body: str | None = None,
+        due_date: datetime | None = None,
+        milestone: int | None = None,
+        ref: str | None = None,
+        state: Literal["closed", "open"] | None = None,
+        title: str | None = None,
+        unset_due_date: bool | None = None,
+        **kwargs: Any,
+    ) -> ClientResponse:
+        """Edit a specific issue in a repository.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            index: The index of the issue.
+            assignee: The new assignee of the issue.
+            assignees: The new assignees of the issue.
+            body: The new body of the issue.
+            due_date: The new due date of the issue.
+            milestone: The new milestone of the issue.
+            ref: The new reference of the issue.
+            state: The new state of the issue.
+            title: The new title of the issue.
+            unset_due_date: Whether to unset the due date of the issue.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response object.
+
+        """
+        endpoint, payload = self._edit_issue_helper(
+            owner=owner,
+            repository=repository,
+            index=index,
+            assignee=assignee,
+            assignees=assignees,
+            body=body,
+            due_date=due_date,
+            milestone=milestone,
+            ref=ref,
+            state=state,
+            title=title,
+            unset_due_date=unset_due_date,
+        )
+        return await self._patch(endpoint=endpoint, json=payload, **kwargs)
+
+    async def edit_issue(  # noqa: PLR0913
+        self,
+        owner: str,
+        repository: str,
+        index: int,
+        assignee: str | None = None,
+        assignees: list[str] | None = None,
+        body: str | None = None,
+        due_date: datetime | None = None,
+        milestone: int | None = None,
+        ref: str | None = None,
+        state: Literal["closed", "open"] | None = None,
+        title: str | None = None,
+        unset_due_date: bool | None = None,
+        **kwargs: Any,
+    ) -> tuple[dict[str, Any], int]:
+        """Edit a specific issue in a repository.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            index: The index of the issue.
+            assignee: The new assignee of the issue.
+            assignees: The new assignees of the issue.
+            body: The new body of the issue.
+            due_date: The new due date of the issue.
+            milestone: The new milestone of the issue.
+            ref: The new reference of the issue.
+            state: The new state of the issue.
+            title: The new title of the issue.
+            unset_due_date: Whether to unset the due date of the issue.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the edited issue as a dictionary and the status code.
+
+        """
+        response = await self._edit_issue(
+            owner=owner,
+            repository=repository,
+            index=index,
+            assignee=assignee,
+            assignees=assignees,
+            body=body,
+            due_date=due_date,
+            milestone=milestone,
+            ref=ref,
+            state=state,
+            title=title,
+            unset_due_date=unset_due_date,
+            **kwargs,
+        )
+        data, status_code = await process_async_response(response)
+        return cast(dict[str, Any], data), status_code