python-gitea 0.3.0__py3-none-any.whl

gitea/user/user.py

@@ -0,0 +1,112 @@
+"""Gitea User resource."""
+
+from __future__ import annotations
+
+from typing import Any, cast
+
+from requests import Response
+
+from gitea.resource.resource import Resource
+from gitea.user.base import BaseUser
+from gitea.utils.response import process_response
+
+
+class User(BaseUser, Resource):
+    """Gitea User resource."""
+
+    def _get_user(self, username: str | None = None, **kwargs: Any) -> Response:
+        """Get user information.
+
+        Args:
+            username: The username of the user to retrieve. If None, retrieves the authenticated user.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The authenticated user's information as a Response object.
+
+        """
+        endpoint, kwargs = self._get_user_helper(username=username, **kwargs)
+        return self._get(endpoint=endpoint, **kwargs)
+
+    def get_user(self, username: str | None = None, **kwargs: Any) -> tuple[dict[str, Any], int]:
+        """Get user information.
+
+        Args:
+            username: The username of the user to retrieve. If None, retrieves the authenticated user.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the user information as a dictionary and the status code.
+
+        """
+        response = self._get_user(username=username, **kwargs)
+        data, status_code = process_response(response)
+        return cast(dict[str, Any], data), status_code
+
+    def _update_user_settings(  # noqa: PLR0913
+        self,
+        diff_view_style: str | None = None,
+        full_name: str | None = None,
+        hide_activity: bool | None = None,
+        hide_email: bool | None = None,
+        language: str | None = None,
+        location: str | None = None,
+        theme: str | None = None,
+        website: str | None = None,
+        **kwargs: Any,
+    ) -> Response:
+        endpoint, payload, kwargs = self._update_user_settings_helper(
+            diff_view_style=diff_view_style,
+            full_name=full_name,
+            hide_activity=hide_activity,
+            hide_email=hide_email,
+            language=language,
+            location=location,
+            theme=theme,
+            website=website,
+            **kwargs,
+        )
+        return self._patch(endpoint=endpoint, json=payload, **kwargs)
+
+    def update_user_settings(  # noqa: PLR0913
+        self,
+        diff_view_style: str | None = None,
+        full_name: str | None = None,
+        hide_activity: bool | None = None,
+        hide_email: bool | None = None,
+        language: str | None = None,
+        location: str | None = None,
+        theme: str | None = None,
+        website: str | None = None,
+        **kwargs: Any,
+    ) -> tuple[dict[str, Any], int]:
+        """Update user settings.
+
+        Args:
+            diff_view_style: The preferred diff view style.
+            full_name: The full name of the user.
+            hide_activity: Whether to hide the user's activity.
+            hide_email: Whether to hide the user's email.
+            language: The preferred language.
+            location: The location of the user.
+            theme: The preferred theme.
+            website: The user's website.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the updated user settings as a dictionary and the status code.
+
+        """
+        response = self._update_user_settings(
+            diff_view_style=diff_view_style,
+            full_name=full_name,
+            hide_activity=hide_activity,
+            hide_email=hide_email,
+            language=language,
+            location=location,
+            theme=theme,
+            website=website,
+            **kwargs,
+        )
+        data, status_code = process_response(response)
+        return cast(dict[str, Any], data), status_code

gitea/utils/__init__.py

@@ -0,0 +1,7 @@
+"""Utility functions for the python-gitea package."""
+
+from __future__ import annotations
+
+from gitea.utils.log import get_version_information, setup_logger
+
+__all__ = ["get_version_information", "setup_logger"]

gitea/utils/log.py

@@ -0,0 +1,70 @@
+"""Utility functions for logging."""
+
+from __future__ import annotations
+
+import logging
+from pathlib import Path
+
+from gitea.version import __version__
+
+
+def get_version_information() -> str:
+    """Get the version information.
+
+    Returns:
+        str: Version information.
+
+    """
+    return __version__
+
+
+def setup_logger(
+    outdir: str = ".", label: str | None = None, log_level: str | int = "INFO", print_version: bool = False
+) -> None:
+    """Set up logging output: call at the start of the script to use.
+
+    Args:
+        outdir: Output directory for log file.
+        label: Label for log file name. If None, no log file is created.
+        log_level: Logging level as string or integer.
+        print_version: Whether to print version information to the log.
+
+    """
+    if isinstance(log_level, str):
+        try:
+            level = getattr(logging, log_level.upper())
+        except AttributeError as e:
+            raise ValueError(f"log_level {log_level} not understood") from e
+    else:
+        level = int(log_level)
+
+    logger = logging.getLogger("python-gitea")
+    logger.propagate = False
+    logger.setLevel(level)
+
+    if not any(
+        isinstance(h, logging.StreamHandler) and not isinstance(h, logging.FileHandler) for h in logger.handlers
+    ):
+        stream_handler = logging.StreamHandler()
+        stream_handler.setFormatter(
+            logging.Formatter("%(asctime)s %(name)s %(levelname)-8s: %(message)s", datefmt="%H:%M")
+        )
+        stream_handler.setLevel(level)
+        logger.addHandler(stream_handler)
+
+    if not any(isinstance(h, logging.FileHandler) for h in logger.handlers) and label:
+        outdir_path = Path(outdir)
+        outdir_path.mkdir(parents=True, exist_ok=True)
+        log_file = outdir_path / f"{label}.log"
+        file_handler = logging.FileHandler(log_file)
+        file_handler.setFormatter(logging.Formatter("%(asctime)s %(levelname)-8s: %(message)s", datefmt="%H:%M"))
+
+        file_handler.setLevel(level)
+        logger.addHandler(file_handler)
+
+    for handler in logger.handlers:
+        handler.setLevel(level)
+
+    if print_version:
+        version = get_version_information()
+        logger.info("Running python-gitea version: %s", version)

gitea/utils/response.py

@@ -0,0 +1,59 @@
+"""Utility functions for processing HTTP responses."""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from aiohttp import ClientResponse
+from requests import Response
+
+logger = logging.getLogger("gitea")
+
+
+def process_response(response: Response) -> tuple[dict[str, Any] | list[dict[str, Any]], int]:
+    """Process a synchronous HTTP response.
+
+    Args:
+        response: The HTTP response object.
+
+    Returns:
+        A tuple containing the response data and status code.
+
+    """
+    status_code = response.status_code
+    if status_code == 204:  # noqa: PLR2004
+        data = {}
+    elif 200 <= status_code < 300:  # noqa: PLR2004
+        try:
+            data = response.json()
+        except ValueError as e:
+            logger.error("Failed to parse JSON response: %s", e)
+            data = {}
+    else:
+        data = {}
+    return data, status_code
+
+
+async def process_async_response(response: ClientResponse) -> tuple[dict[str, Any] | list[dict[str, Any]], int]:
+    """Process an asynchronous HTTP response.
+
+    Args:
+        response: The asynchronous HTTP response object.
+
+    Returns:
+        A tuple containing the response data and status code.
+
+    """
+    status_code = response.status
+    if status_code == 204:  # noqa: PLR2004
+        data = {}
+    elif 200 <= status_code < 300:  # noqa: PLR2004
+        try:
+            data = await response.json()
+        except ValueError as e:
+            logger.error("Failed to parse JSON response: %s", e)
+            data = {}
+    else:
+        data = {}
+    return data, status_code

gitea/version.py

@@ -0,0 +1,11 @@
+"""A script to infer the version number from the metadata."""
+
+from __future__ import annotations
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("python-gitea")
+except PackageNotFoundError:
+    # Fallback for source checkouts or environments without installed metadata.
+    __version__ = "0+unknown"

python_gitea-0.3.0.dist-info/METADATA

@@ -0,0 +1,185 @@
+Metadata-Version: 2.4
+Name: python-gitea
+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
+Project-URL: Tracker, https://github.com/isaac-cf-wong/python-gitea/issues
+Project-URL: Home, https://github.com/isaac-cf-wong/python-gitea
+Project-URL: Release Notes, https://github.com/isaac-cf-wong/python-gitea/releases
+Author-email: "Isaac C. F. Wong" <isaac.cf.wong@gmail.com>
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: aiohttp<4.0.0,>=3.8.0
+Requires-Dist: requests<3.0.0,>=2.32.0
+Requires-Dist: typer<1.0.0,>=0.21.0
+Provides-Extra: dev
+Requires-Dist: black; extra == 'dev'
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mike; extra == 'docs'
+Requires-Dist: mkdocs; extra == 'docs'
+Requires-Dist: mkdocs-gen-files; extra == 'docs'
+Requires-Dist: mkdocs-literate-nav; extra == 'docs'
+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.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'
+Requires-Dist: flake8-docstrings; extra == 'test'
+Requires-Dist: flake8-formatter-junit-xml; extra == 'test'
+Requires-Dist: flake8-pyproject; extra == 'test'
+Requires-Dist: pre-commit==4.5.1; extra == 'test'
+Requires-Dist: pytest-asyncio; extra == 'test'
+Requires-Dist: pytest-cov==7.0.0; extra == 'test'
+Requires-Dist: pytest-github-actions-annotate-failures; extra == 'test'
+Requires-Dist: pytest-mock<3.15.2; extra == 'test'
+Requires-Dist: pytest-runner; extra == 'test'
+Requires-Dist: pytest==9.0.2; extra == 'test'
+Requires-Dist: shellcheck-py==0.11.0.1; extra == 'test'
+Description-Content-Type: text/markdown
+
+# python-gitea
+
+[![Python CI](https://github.com/isaac-cf-wong/python-gitea/actions/workflows/CI.yml/badge.svg)](https://github.com/isaac-cf-wong/python-gitea/actions/workflows/CI.yml)
+[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/isaac-cf-wong/python-gitea/main.svg)](https://results.pre-commit.ci/latest/github/isaac-cf-wong/python-gitea/main)
+[![Documentation Status](https://github.com/isaac-cf-wong/python-gitea/actions/workflows/documentation.yml/badge.svg)](https://isaac-cf-wong.github.io/python-gitea/)
+[![codecov](https://codecov.io/gh/isaac-cf-wong/python-gitea/graph/badge.svg?token=COF8341N60)](https://codecov.io/gh/isaac-cf-wong/python-gitea)
+[![PyPI Version](https://img.shields.io/pypi/v/python-gitea)](https://pypi.org/project/python-gitea/)
+[![Python Versions](https://img.shields.io/pypi/pyversions/python-gitea)](https://pypi.org/project/python-gitea/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+[![Security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
+[![DOI](https://zenodo.org/badge/1129170965.svg)](https://doi.org/10.5281/zenodo.18211496)
+
+**Note:** This project is still in progress. The promised features are not fully ready yet, and APIs are subject to change.
+
+A Python package for interacting with the Gitea API.
+This package provides a simple and intuitive interface to access Gitea repositories, users, organizations, issues, and more,
+enabling seamless integration with Gitea instances for automation, data retrieval, and management tasks.
+
+## Features
+
+Full API Coverage: Access to repositories, users, organizations, issues, pull requests, and more.
+
+- Easy Authentication: Support for token-based authentication.
+- Asynchronous Support: Built with async/await for non-blocking operations.
+- Type Hints: Full type annotations for better IDE support and code reliability.
+- Comprehensive Documentation: Detailed guides and API reference.
+- Command-Line Interface: Interact with the Gitea API directly from the terminal for
+  quick, scriptable operations without writing code.
+
+## Installation
+
+We recommend using `uv` to manage virtual environments for installing `python-gitea`.
+
+If you don't have `uv` installed, you can install it with pip. See the project pages for more details:
+
+- Install via pip: `pip install --upgrade pip && pip install uv`
+- Project pages: [uv on PyPI](https://pypi.org/project/uv/) | [uv on GitHub](https://github.com/astral-sh/uv)
+- Full documentation and usage guide: [uv docs](https://docs.astral.sh/uv/)
+
+### Requirements
+
+- Python 3.10 or higher
+- Operating System: Linux, macOS, or Windows
+
+### Install from PyPI
+
+The recommended way to install `python-gitea` is from PyPI:
+
+```bash
+# Create a virtual environment (recommended with uv)
+uv venv --python 3.10
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv pip install python-gitea
+```
+
+#### Optional Dependencies
+
+For development or specific features:
+
+```bash
+# Development dependencies (testing, linting, etc.)
+uv pip install python-gitea[dev]
+
+# Documentation dependencies
+uv pip install python-gitea[docs]
+
+# All dependencies
+uv pip install python-gitea[dev,docs]
+```
+
+### Install from Source
+
+For the latest development version:
+
+```bash
+git clone git@github.com:isaac-cf-wong/python-gitea.git
+cd python-gitea
+# Create a virtual environment (recommended with uv)
+uv venv --python 3.10
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv pip install .
+```
+
+#### Development Installation
+
+To set up for development:
+
+```bash
+git clone git@github.com:isaac-cf-wong/python-gitea.git
+cd python-gitea
+
+# Create a virtual environment (recommended with uv)
+uv venv --python 3.10
+source .venv/bin/activate  # On Windows: .venv\Scripts\activate
+uv pip install ".[dev]"
+
+# Install the commitlint dependencies
+npm install
+
+# Install pre-commit hooks
+pre-commit install
+pre-commit install --hook-type commit-msg
+```
+
+### Verify Installation
+
+Check that `python-gitea` is installed correctly:
+
+```bash
+gitea-cli --help
+```
+
+```bash
+python -c "import gitea; print(gitea.__version__)"
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Support
+
+For questions, issues, or contributions, please:
+
+- Check the [documentation](https://isaac-cf-wong.github.io/python-gitea/)
+- Open an issue on [GitHub](https://github.com/isaac-cf-wong/python-gitea/issues)
+- Join our [discussions](https://github.com/isaac-cf-wong/python-gitea/discussions)
+
+## Changelog
+
+See [Release Notes](https://github.com/isaac-cf-wong/python-gitea/releases) for version history.

python_gitea-0.3.0.dist-info/RECORD

@@ -0,0 +1,37 @@
+gitea/__init__.py,sha256=88oOBMq7_jb4Lj_50Rnm7sLGgwVVf2F4CtrXa8wHtGo,144
+gitea/__main__.py,sha256=VxrPtOzhGWtiYFtbMf9HZfBOq69f1-6wiZKUgChCi9k,200
+gitea/version.py,sha256=9VocG55BuA7PWHyEMjaq6vqnsLFfT4wQ5I0zSrianLg,347
+gitea/cli/__init__.py,sha256=a7N3aSLhu10Tqeg6AbQWQMiTLiBhLa7kKFiNtXJ33dY,40
+gitea/cli/main.py,sha256=Hdtja67e4Gx4kntA2UT1wn9TWMsv8kUenwwGOTEMHfY,3317
+gitea/cli/utils.py,sha256=hSg2NsBXkdkYbX9A8wDCrF40DOAt5AH8vYHGopNTygg,1252
+gitea/cli/user/__init__.py,sha256=vy_rPJPeapNmXT0_X6p3ljlmEJcBOlTok4r1kq7N8mA,36
+gitea/cli/user/delete_user_level_runner.py,sha256=xqZRz8Ux7ga0YSAb5D8mNn0pkWc7HA5y8RPjqMb1-xU,1207
+gitea/cli/user/get_registration_token.py,sha256=BYwAfYitaQ7xOfbbena5i272geIH5dNYFsNRwosxiSQ,936
+gitea/cli/user/get_user.py,sha256=KwUubEypRMNq5PZyvNwmBbYVu3-7VKHdwmrocTi4Bko,1190
+gitea/cli/user/get_user_level_runners.py,sha256=HDWnvUZYzdzwVdM1rtMzB7bZuvhjV3GgNLkdKlluTSw,1103
+gitea/cli/user/get_workflow_jobs.py,sha256=Yp3Svvjaf_LaxalJaTTQ7ag5aJv0ltZtnFuMFWo10dU,1821
+gitea/cli/user/get_workflow_runs.py,sha256=OAzAae-EytAd1q6YldM_njj77zsx91WrrTZ1ABL8qXE,2557
+gitea/cli/user/main.py,sha256=Q1SzPwlHcmjK99FvRlPx94uYWe2honp5q9f_nPR79y8,1250
+gitea/client/__init__.py,sha256=tWyILBf_tdTP1F6tf0NrNtgeEOYDRkc2QlHaga7GIo8,185
+gitea/client/async_gitea.py,sha256=3JNb30PmnVFLsJf6PFBLlkzkxNPXlGYI-Z5g54scj0k,3459
+gitea/client/base.py,sha256=4COF3_TBfSb9X8Zj3vDdBYlmtKyd6WkjpaD6wIu020A,1138
+gitea/client/gitea.py,sha256=WFt2Ewm0jZcJkxRG4-UfeEO3Me9eWuVjjNCZ4cqZSSY,2768
+gitea/issue/__init__.py,sha256=0n6hG36CA9hiiEQ8DC2gqacfI7sw26YojVp61GnrL60,183
+gitea/issue/async_issue.py,sha256=bd-6N_Njk564NdFGv6Xa94B_QbbG4thEnxmvYsR0RL8,10027
+gitea/issue/base.py,sha256=3UCCh_HfPCqCtgL0i2LnXQ8HqbI97WORDXQMdUH7D-Y,7192
+gitea/issue/issue.py,sha256=vBQpIxW7lnQY18FFXqjLD2LYtNwJqYJJSFxDFtgGl4Y,9843
+gitea/resource/__init__.py,sha256=JIn9d6nLh9RyFAugFFhgKiKTBO2IR8bWtLBVT46aYGM,37
+gitea/resource/async_resource.py,sha256=nDiUmZJpX9TqzfLmq869gDHrrHy7OWJbVrHKG7oVEB8,2506
+gitea/resource/resource.py,sha256=0za0iWeag1SK9NNdTFKRNOw6b02zbIlAYDzA587l7qQ,2269
+gitea/user/__init__.py,sha256=Oj9f6kSZtFMuRlTaP_SeP0Jkz3lSP542Wjhu86AD04k,33
+gitea/user/async_user.py,sha256=qWN5ByMwRklM7UUblen-DqFhM0MXkoBFLEQX5BGHPYc,4630
+gitea/user/base.py,sha256=wNOfgHNyYZc68XIuCsXmorMC3ce_AOpLRD1KKr5k-_8,3859
+gitea/user/user.py,sha256=2NddcqaRPj0j95mc36KwW2UFxxlU6cwAKJGSJDrtYZo,3839
+gitea/utils/__init__.py,sha256=aP0FsAkvhZAoKrlaEWWvx_F7KU0HPqWhKElyBdEyTyk,212
+gitea/utils/log.py,sha256=U_MfLFsUneCjomZegUlXuQe6O0CUpq1_-5o6sfv6iLQ,2233
+gitea/utils/response.py,sha256=yqMMOmBzJ8dF4-TWOStS5OymbzC6VkTcR_oQSyJS42I,1583
+python_gitea-0.3.0.dist-info/METADATA,sha256=kUe5axX6kdTOHWl2L8K486sYUGAAHSEWlP6soxcSlaQ,7251
+python_gitea-0.3.0.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+python_gitea-0.3.0.dist-info/entry_points.txt,sha256=m5yt-1RMRZRFMj_M-Un5E4eOkM113S9EppAHp0aCzEY,49
+python_gitea-0.3.0.dist-info/licenses/LICENSE,sha256=4dW9zcCxiQKAu4CyNKJTRmvzdJCCHDxbPGuQ-YALpsY,1137
+python_gitea-0.3.0.dist-info/RECORD,,

python_gitea-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

python_gitea-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gitea-cli = gitea.cli.main:app

python_gitea-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) 2025 isaac-cf-wong
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE