GitHubKit-schemas 26.6.7__tar.gz

githubkit_schemas-26.6.7/PKG-INFO

@@ -0,0 +1,95 @@
+Metadata-Version: 2.4
+Name: GitHubKit-schemas
+Version: 26.6.7
+Summary: GitHub Schemas for GitHubKit
+Keywords: github,octokit
+Author: yanyongyu
+Author-email: yanyongyu <yyy@yyydl.top>
+License-Expression: MIT
+Requires-Dist: githubkit>=0.16.0
+Requires-Dist: githubkit-schemas-2026-03-10==26.6.7
+Requires-Dist: githubkit-schemas-2022-11-28==26.6.7 ; extra == '2022-11-28'
+Requires-Dist: githubkit-schemas-2026-03-10==26.6.7 ; extra == '2026-03-10'
+Requires-Dist: githubkit-schemas-2022-11-28==26.6.7 ; extra == 'all'
+Requires-Dist: githubkit-schemas-2026-03-10==26.6.7 ; extra == 'all'
+Requires-Dist: githubkit-schemas-ghec-2022-11-28==26.6.7 ; extra == 'all'
+Requires-Dist: githubkit-schemas-ghec-2026-03-10==26.6.7 ; extra == 'all'
+Requires-Dist: githubkit-schemas-2022-11-28==26.6.7 ; extra == 'all-gh'
+Requires-Dist: githubkit-schemas-2026-03-10==26.6.7 ; extra == 'all-gh'
+Requires-Dist: githubkit-schemas-ghec-2022-11-28==26.6.7 ; extra == 'all-ghec'
+Requires-Dist: githubkit-schemas-ghec-2026-03-10==26.6.7 ; extra == 'all-ghec'
+Requires-Dist: githubkit-schemas-ghec-2026-03-10==26.6.7 ; extra == 'ghec'
+Requires-Dist: githubkit-schemas-ghec-2022-11-28==26.6.7 ; extra == 'ghec-2022-11-28'
+Requires-Dist: githubkit-schemas-ghec-2026-03-10==26.6.7 ; extra == 'ghec-2026-03-10'
+Requires-Python: >=3.10, <4.0
+Project-URL: Homepage, https://github.com/yanyongyu/githubkit
+Project-URL: Repository, https://github.com/yanyongyu/githubkit
+Project-URL: Documentation, https://github.com/yanyongyu/githubkit
+Project-URL: Bug Tracker, https://github.com/yanyongyu/githubkit/issues
+Provides-Extra: 2022-11-28
+Provides-Extra: 2026-03-10
+Provides-Extra: all
+Provides-Extra: all-gh
+Provides-Extra: all-ghec
+Provides-Extra: ghec
+Provides-Extra: ghec-2022-11-28
+Provides-Extra: ghec-2026-03-10
+Description-Content-Type: text/markdown
+
+<!-- markdownlint-disable MD041 -->
+<div align="center">
+
+[![githubkit](https://socialify.git.ci/yanyongyu/githubkit/image?custom_description=%E2%9C%A8+The+modern%2C+all-batteries-included+GitHub+SDK+for+Python+%E2%9C%A8&description=1&descriptionEditable=%E2%9C%A8+GitHub+SDK+for+Python+%E2%9C%A8&font=Bitter&language=1&pattern=Circuit+Board&theme=Light)](https://github.com/yanyongyu/githubkit)
+
+</div>
+
+<p align="center">
+  <a href="https://raw.githubusercontent.com/yanyongyu/githubkit/master/LICENSE">
+    <img src="https://img.shields.io/github/license/yanyongyu/githubkit" alt="license">
+  </a>
+  <a href="https://pypi.python.org/pypi/githubkit-schemas">
+    <img src="https://img.shields.io/pypi/v/githubkit-schemas?logo=python&logoColor=edb641" alt="pypi">
+  </a>
+  <img src="https://img.shields.io/badge/python-3.10+-blue?logo=python&logoColor=edb641" alt="python">
+  <a href="https://github.com/psf/black">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=edb641" alt="black">
+  </a>
+  <a href="https://github.com/Microsoft/pyright">
+    <img src="https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641" alt="pyright">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="ruff">
+  </a>
+  <a href="https://results.pre-commit.ci/latest/github/yanyongyu/githubkit/master">
+    <img src="https://results.pre-commit.ci/badge/github/yanyongyu/githubkit/master.svg" alt="pre-commit" />
+  </a>
+</p>
+
+<div align="center">
+
+<!-- markdownlint-capture -->
+<!-- markdownlint-disable MD036 -->
+
+_✨ The modern, all-batteries-included GitHub SDK for Python ✨_
+
+_✨ Support both **sync** and **async** calls, **fully typed** ✨_
+
+_✨ Always up to date, like octokit ✨_
+
+<!-- markdownlint-restore -->
+
+</div>
+
+<p align="center">
+  <a href="https://yanyongyu.github.io/githubkit/"><b>Documentation</b></a> |
+  <a href="https://github.com/yanyongyu/githubkit/issues"><b>Report Bug</b></a> |
+  <a href="https://docs.github.com/"><b>GitHub Docs</b></a>
+</p>
+
+This package provides the models and GitHub schemas for GitHubKit. It is installed as a dependency of GitHubKit by default, so you don't need to install it separately.
+
+When GitHub schemas are updated, this package will be updated accordingly. You can also lock the version of this package using a dependency manager like `uv` to ensure that your project is using a specific version of the schemas.
+
+## Getting Started
+
+For more, see the [documentation](https://yanyongyu.github.io/githubkit).

githubkit_schemas-26.6.7/README.md

@@ -0,0 +1,57 @@
+<!-- markdownlint-disable MD041 -->
+<div align="center">
+
+[![githubkit](https://socialify.git.ci/yanyongyu/githubkit/image?custom_description=%E2%9C%A8+The+modern%2C+all-batteries-included+GitHub+SDK+for+Python+%E2%9C%A8&description=1&descriptionEditable=%E2%9C%A8+GitHub+SDK+for+Python+%E2%9C%A8&font=Bitter&language=1&pattern=Circuit+Board&theme=Light)](https://github.com/yanyongyu/githubkit)
+
+</div>
+
+<p align="center">
+  <a href="https://raw.githubusercontent.com/yanyongyu/githubkit/master/LICENSE">
+    <img src="https://img.shields.io/github/license/yanyongyu/githubkit" alt="license">
+  </a>
+  <a href="https://pypi.python.org/pypi/githubkit-schemas">
+    <img src="https://img.shields.io/pypi/v/githubkit-schemas?logo=python&logoColor=edb641" alt="pypi">
+  </a>
+  <img src="https://img.shields.io/badge/python-3.10+-blue?logo=python&logoColor=edb641" alt="python">
+  <a href="https://github.com/psf/black">
+    <img src="https://img.shields.io/badge/code%20style-black-000000.svg?logo=python&logoColor=edb641" alt="black">
+  </a>
+  <a href="https://github.com/Microsoft/pyright">
+    <img src="https://img.shields.io/badge/types-pyright-797952.svg?logo=python&logoColor=edb641" alt="pyright">
+  </a>
+  <a href="https://github.com/astral-sh/ruff">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json" alt="ruff">
+  </a>
+  <a href="https://results.pre-commit.ci/latest/github/yanyongyu/githubkit/master">
+    <img src="https://results.pre-commit.ci/badge/github/yanyongyu/githubkit/master.svg" alt="pre-commit" />
+  </a>
+</p>
+
+<div align="center">
+
+<!-- markdownlint-capture -->
+<!-- markdownlint-disable MD036 -->
+
+_✨ The modern, all-batteries-included GitHub SDK for Python ✨_
+
+_✨ Support both **sync** and **async** calls, **fully typed** ✨_
+
+_✨ Always up to date, like octokit ✨_
+
+<!-- markdownlint-restore -->
+
+</div>
+
+<p align="center">
+  <a href="https://yanyongyu.github.io/githubkit/"><b>Documentation</b></a> |
+  <a href="https://github.com/yanyongyu/githubkit/issues"><b>Report Bug</b></a> |
+  <a href="https://docs.github.com/"><b>GitHub Docs</b></a>
+</p>
+
+This package provides the models and GitHub schemas for GitHubKit. It is installed as a dependency of GitHubKit by default, so you don't need to install it separately.
+
+When GitHub schemas are updated, this package will be updated accordingly. You can also lock the version of this package using a dependency manager like `uv` to ensure that your project is using a specific version of the schemas.
+
+## Getting Started
+
+For more, see the [documentation](https://yanyongyu.github.io/githubkit).

githubkit_schemas-26.6.7/githubkit_schemas/core/__init__.py

@@ -0,0 +1,22 @@
+"""DO NOT EDIT THIS FILE!
+
+This file is automatically @generated by githubkit using the follow command:
+
+bash ./scripts/run-codegen.sh
+
+See https://github.com/github/rest-api-description for more information.
+"""
+
+from typing import Literal
+
+VERSIONS = {
+    "2022-11-28": "v2022_11_28",
+    "ghec-2022-11-28": "ghec_v2022_11_28",
+    "2026-03-10": "v2026_03_10",
+    "ghec-2026-03-10": "ghec_v2026_03_10",
+}
+LATEST_VERSION = "2026-03-10"
+VERSION_TYPE = Literal["2022-11-28", "ghec-2022-11-28", "2026-03-10", "ghec-2026-03-10"]
+
+from .rest import RestVersionSwitcher as RestVersionSwitcher
+from .webhooks import WebhooksVersionSwitcher as WebhooksVersionSwitcher

githubkit_schemas-26.6.7/githubkit_schemas/core/rest.py

@@ -0,0 +1,150 @@
+"""DO NOT EDIT THIS FILE!
+
+This file is automatically @generated by githubkit using the follow command:
+
+bash ./scripts/run-codegen.sh
+
+See https://github.com/github/rest-api-description for more information.
+"""
+
+from collections.abc import Awaitable, Callable
+import importlib
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Literal,
+    TypeVar,
+    overload,
+)
+from typing_extensions import ParamSpec
+from weakref import WeakKeyDictionary, ref
+
+from githubkit.rest.paginator import Paginator
+
+from . import LATEST_VERSION, VERSION_TYPE, VERSIONS
+
+if TYPE_CHECKING:
+    from githubkit_schemas.ghec_v2022_11_28.rest import (
+        RestNamespace as GhecV20221128RestNamespace,
+    )
+    from githubkit_schemas.ghec_v2026_03_10.rest import (
+        RestNamespace as GhecV20260310RestNamespace,
+    )
+    from githubkit_schemas.v2022_11_28.rest import (
+        RestNamespace as V20221128RestNamespace,
+    )
+    from githubkit_schemas.v2026_03_10.rest import (
+        RestNamespace as V20260310RestNamespace,
+    )
+
+    from githubkit import GitHubCore, Response
+
+
+CP = ParamSpec("CP")
+CT = TypeVar("CT")
+RT = TypeVar("RT")
+
+R = Callable[CP, "Response[RT]"] | Callable[CP, Awaitable["Response[RT]"]]
+
+if TYPE_CHECKING:
+
+    class _VersionProxy(V20260310RestNamespace): ...
+
+else:
+    _VersionProxy = object
+
+
+class RestVersionSwitcher(_VersionProxy):
+    _cached_namespaces: "WeakKeyDictionary[GitHubCore, dict[VERSION_TYPE, Any]]" = (
+        WeakKeyDictionary()
+    )
+
+    if not TYPE_CHECKING:
+
+        def __getattr__(self, name: str) -> Any:
+            if name.startswith("_"):
+                raise AttributeError(
+                    f"'{self.__class__.__name__}' object has no attribute '{name}'"
+                )
+            namespace = self()
+            return getattr(namespace, name)
+
+    def __init__(self, github: "GitHubCore"):
+        self._github_ref = ref(github)
+
+    @property
+    def _github(self) -> "GitHubCore":
+        if g := self._github_ref():
+            return g
+        raise RuntimeError(
+            "GitHub client has already been collected. "
+            "Do not use the namespace after the client has been collected."
+        )
+
+    @overload
+    def paginate(
+        self,
+        request: "R[CP, list[RT]]",
+        map_func: None = None,
+        *args: CP.args,
+        **kwargs: CP.kwargs,
+    ) -> "Paginator[RT]": ...
+
+    @overload
+    def paginate(
+        self,
+        request: "R[CP, CT]",
+        map_func: Callable[["Response[CT]"], list[RT]],
+        *args: CP.args,
+        **kwargs: CP.kwargs,
+    ) -> "Paginator[RT]": ...
+
+    def paginate(
+        self,
+        request: "R[CP, CT]",
+        map_func: Callable[["Response[CT]"], list[RT]] | None = None,
+        *args: CP.args,
+        **kwargs: CP.kwargs,
+    ) -> "Paginator[RT]":
+        return Paginator(self, request, map_func, *args, **kwargs)  # type: ignore
+
+    @overload
+    def __call__(self, version: Literal["2022-11-28"]) -> "V20221128RestNamespace": ...
+    @overload
+    def __call__(
+        self, version: Literal["ghec-2022-11-28"]
+    ) -> "GhecV20221128RestNamespace": ...
+    @overload
+    def __call__(self, version: Literal["2026-03-10"]) -> "V20260310RestNamespace": ...
+    @overload
+    def __call__(
+        self, version: Literal["ghec-2026-03-10"]
+    ) -> "GhecV20260310RestNamespace": ...
+
+    @overload
+    def __call__(self) -> "V20260310RestNamespace": ...
+
+    def __call__(self, version: VERSION_TYPE = LATEST_VERSION) -> Any:
+        g = self._github
+        cache = self._cached_namespaces.setdefault(g, {})
+        if version in cache:
+            return cache[version]
+
+        if version not in VERSIONS:
+            raise ValueError(
+                f"Version {version!r} is not a valid version. "
+                f"Valid versions are: {', '.join(VERSIONS.keys())}"
+            )
+
+        try:
+            module = importlib.import_module(
+                f"githubkit_schemas.{VERSIONS[version]}.rest"
+            )
+        except ModuleNotFoundError:
+            raise RuntimeError(
+                f"Version {version!r} is not installed. "
+                f"Please install it via 'pip install githubkit-schemas[{version}]'"
+            )
+        namespace = module.RestNamespace(g)
+        cache[version] = namespace
+        return namespace

githubkit_schemas-26.6.7/githubkit_schemas/core/webhooks.py

@@ -0,0 +1,91 @@
+"""DO NOT EDIT THIS FILE!
+
+This file is automatically @generated by githubkit using the follow command:
+
+bash ./scripts/run-codegen.sh
+
+See https://github.com/github/rest-api-description for more information.
+"""
+
+import importlib
+from typing import TYPE_CHECKING, Any, ClassVar, Literal, overload
+
+from . import LATEST_VERSION, VERSION_TYPE, VERSIONS
+
+if TYPE_CHECKING:
+    from githubkit_schemas.ghec_v2022_11_28.webhooks import (
+        WebhookNamespace as GhecV20221128WebhookNamespace,
+    )
+    from githubkit_schemas.ghec_v2026_03_10.webhooks import (
+        WebhookNamespace as GhecV20260310WebhookNamespace,
+    )
+    from githubkit_schemas.v2022_11_28.webhooks import (
+        WebhookNamespace as V20221128WebhookNamespace,
+    )
+    from githubkit_schemas.v2026_03_10.webhooks import (
+        WebhookNamespace as V20260310WebhookNamespace,
+    )
+
+if TYPE_CHECKING:
+
+    class _VersionProxy(V20260310WebhookNamespace): ...
+
+else:
+    _VersionProxy = object
+
+
+class WebhooksVersionSwitcher(_VersionProxy):
+    _cached_namespaces: ClassVar[dict[VERSION_TYPE, Any]] = {}
+
+    if not TYPE_CHECKING:
+
+        def __getattr__(self, name: str) -> Any:
+            if name.startswith("_"):
+                raise AttributeError(
+                    f"'{self.__class__.__name__}' object has no attribute '{name}'"
+                )
+            namespace = self()
+            return getattr(namespace, name)
+
+    @overload
+    def __call__(
+        self, version: Literal["2022-11-28"]
+    ) -> "V20221128WebhookNamespace": ...
+    @overload
+    def __call__(
+        self, version: Literal["ghec-2022-11-28"]
+    ) -> "GhecV20221128WebhookNamespace": ...
+    @overload
+    def __call__(
+        self, version: Literal["2026-03-10"]
+    ) -> "V20260310WebhookNamespace": ...
+    @overload
+    def __call__(
+        self, version: Literal["ghec-2026-03-10"]
+    ) -> "GhecV20260310WebhookNamespace": ...
+
+    @overload
+    def __call__(self) -> "V20260310WebhookNamespace": ...
+
+    def __call__(self, version: VERSION_TYPE = LATEST_VERSION) -> Any:
+        if version in self._cached_namespaces:
+            return self._cached_namespaces[version]
+
+        if version not in VERSIONS:
+            raise ValueError(
+                f"Version {version!r} is not a valid version. "
+                f"Valid versions are: {', '.join(VERSIONS.keys())}"
+            )
+
+        try:
+            module = importlib.import_module(
+                f"githubkit_schemas.{VERSIONS[version]}.webhooks"
+            )
+        except ModuleNotFoundError:
+            raise RuntimeError(
+                f"Version {version!r} is not installed. "
+                f"Please install it via 'pip install githubkit-schemas[{version}]'"
+            )
+        namespace = module.WebhookNamespace()
+        self._cached_namespaces[version] = namespace
+        return namespace

githubkit_schemas-26.6.7/githubkit_schemas/latest/__init__.py

@@ -0,0 +1,8 @@
+"""DO NOT EDIT THIS FILE!
+
+This file is automatically @generated by githubkit using the follow command:
+
+bash ./scripts/run-codegen.sh
+
+See https://github.com/github/rest-api-description for more information.
+"""