gitcode-api 1.2.13__tar.gz → 1.2.14__tar.gz

{gitcode_api-1.2.13 → gitcode_api-1.2.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitcode-api
-Version: 1.2.13
+Version: 1.2.14
 Summary: Easy to use Python SDK for the GitCode REST API. Providing builtin CLI tool, and optional LLM integration (MCP, OpenAI tool, and openJiuwen tool) for agents. Community-maintained.
 Author-email: Hugo Huang <hugo@hugohuang.com>
 License-Expression: MIT
@@ -37,7 +37,7 @@ Dynamic: license-file
 
 # GitCode-API
 
-[![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api?link=https%3A%2F%2Fpypi.org%2Fproject%2Fgitcode-api%2F&uuid=d15040ff268342bca07ad60f812924a7)](https://pypi.org/project/gitcode-api) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/gitcode-api?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=RED&left_text=downloads&uuid=b7f4a02b5f3e4776bd62a22cc539074b)](https://pepy.tech/projects/gitcode-api) [![CodeFactor](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api/badge)](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api)
+[![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api?link=https%3A%2F%2Fpypi.org%2Fproject%2Fgitcode-api%2F&uuid=0f8b00a32fc94f54983f4805335c3eb4)](https://pypi.org/project/gitcode-api) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/gitcode-api?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=RED&left_text=downloads&uuid=a33b3f8410bf4c44a854d69b7d1b3328)](https://pepy.tech/projects/gitcode-api) [![CodeFactor](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api/badge)](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api)
 [![Install in Cursor](https://img.shields.io/badge/Install_in-Cursor-000000?logoColor=white)](https://cursor.com/en/install-mcp?name=GitCode%20API&config=eyJjb21tYW5kIjoidXZ4IiwiYXJncyI6WyItLWZyb20iLCJnaXRjb2RlLWFwaVttY3BdIiwiZ2l0Y29kZS1hcGkiLCJzZXJ2ZSJdLCJlbnYiOnsiR0lUQ09ERV9BQ0NFU1NfVE9LRU4iOiIke2lucHV0OmdpdGNvZGVfYWNjZXNzX3Rva2VufSJ9LCJpbnB1dHMiOlt7ImlkIjoiZ2l0Y29kZV9hY2Nlc3NfdG9rZW4iLCJ0eXBlIjoicHJvbXB0U3RyaW5nIiwiZGVzY3JpcHRpb24iOiJFbnRlciBHSVRDT0RFX0FDQ0VTU19UT0tFTiIsInBhc3N3b3JkIjp0cnVlfV19) [![Install in VS Code](https://img.shields.io/badge/Install_in-VS_Code-0098FF?logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect/mcp/install?name=GitCode%20API&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22--from%22%2C%22gitcode-api%5Bmcp%5D%22%2C%22gitcode-api%22%2C%22serve%22%5D%2C%22env%22%3A%7B%22GITCODE_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agitcode_access_token%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22gitcode_access_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Enter%20GITCODE_ACCESS_TOKEN%22%2C%22password%22%3Atrue%7D%5D%7D)
 [![GitHub Badge](https://img.shields.io/badge/github-repo-blue?logo=github&link=https%3A%2F%2Fgithub.com%2FTrenza1ore%2FGitCode-API)](https://github.com/Trenza1ore/GitCode-API) [![GitCode Badge](https://img.shields.io/badge/gitcode-repo-brown?logo=gitcode&link=https%3A%2F%2Fgitcode.com%2FSushiNinja%2FGitCode-API)](https://gitcode.com/SushiNinja/GitCode-API)
 
@@ -49,6 +49,7 @@ Dynamic: license-file
 
 - Community project for developers who want a practical GitCode Python library.
 - Sync and async clients with a consistent API surface.
+- Convenient methods not offered by REST API directly: such as fetching Issue and PR templates.
 - Resource groups such as `client.repos`, `client.pulls`, and `client.users`.
 - Repository defaults via `owner=` and `repo=` on the client.
 - Sphinx docs plus a mirrored GitCode REST API reference in `docs/`.
@@ -153,6 +154,21 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
+### Convert typed return objects to dicts with `as_dict`
+
+Response values are typed `APIObject` subclasses. For serialization or code that expects built-in `dict`, import `as_dict` from the package root: pass a single model to get a `dict`, or pass a list (for example from `client.pulls.list(...)`) to get `list[dict]`. This mirrors the idea of `dataclasses.asdict` but uses each model’s `to_dict()` method. Use `deep_copy=True` when you need detached deep copies.
+
+```python
+from gitcode_api import GitCode, as_dict
+
+client = GitCode(owner="SushiNinja")
+pulls = client.pulls.list_templates(repo="GitCode-API")
+payload = as_dict(pulls)  # list[dict]
+
+repo = client.repos.get(repo="GitCode-API")
+meta = as_dict(repo)  # dict
+```
+
 ### Context managers
 
 `GitCode` and `AsyncGitCode` (and the lower-level `SyncAPIClient` / `AsyncAPIClient`) support `with` / `async with`. Leaving the block calls `close()` / `await close()` on the underlying client automatically, including a custom `http_client=` you passed in. `close()` also clears the LRU cache used by each resource group's `method_signature(...)` helper (see the [Available Resources](#available-resources) section).
@@ -354,6 +370,8 @@ Runnable examples live in `examples/`:
 
 - `get_current_user.py`
 - `get_repository_overview.py`
+- `get_issue_templates.py`
+- `get_pull_request_templates.py`
 - `list_pull_requests.py`
 - `async_list_branches.py`
 
@@ -362,6 +380,8 @@ Example scripts load shared configuration from `examples/.env` using `python-dot
 ```bash
 uv run python examples/get_current_user.py
 uv run python examples/get_repository_overview.py
+uv run python examples/get_issue_templates.py
+uv run python examples/get_pull_request_templates.py
 uv run python examples/list_pull_requests.py
 uv run python examples/async_list_branches.py
 ```

{gitcode_api-1.2.13 → gitcode_api-1.2.14}/README.md

@@ -1,6 +1,6 @@
 # GitCode-API
 
-[![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api?link=https%3A%2F%2Fpypi.org%2Fproject%2Fgitcode-api%2F&uuid=d15040ff268342bca07ad60f812924a7)](https://pypi.org/project/gitcode-api) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/gitcode-api?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=RED&left_text=downloads&uuid=b7f4a02b5f3e4776bd62a22cc539074b)](https://pepy.tech/projects/gitcode-api) [![CodeFactor](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api/badge)](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api)
+[![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api?link=https%3A%2F%2Fpypi.org%2Fproject%2Fgitcode-api%2F&uuid=0f8b00a32fc94f54983f4805335c3eb4)](https://pypi.org/project/gitcode-api) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/gitcode-api?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=RED&left_text=downloads&uuid=a33b3f8410bf4c44a854d69b7d1b3328)](https://pepy.tech/projects/gitcode-api) [![CodeFactor](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api/badge)](https://www.codefactor.io/repository/github/trenza1ore/gitcode-api)
 [![Install in Cursor](https://img.shields.io/badge/Install_in-Cursor-000000?logoColor=white)](https://cursor.com/en/install-mcp?name=GitCode%20API&config=eyJjb21tYW5kIjoidXZ4IiwiYXJncyI6WyItLWZyb20iLCJnaXRjb2RlLWFwaVttY3BdIiwiZ2l0Y29kZS1hcGkiLCJzZXJ2ZSJdLCJlbnYiOnsiR0lUQ09ERV9BQ0NFU1NfVE9LRU4iOiIke2lucHV0OmdpdGNvZGVfYWNjZXNzX3Rva2VufSJ9LCJpbnB1dHMiOlt7ImlkIjoiZ2l0Y29kZV9hY2Nlc3NfdG9rZW4iLCJ0eXBlIjoicHJvbXB0U3RyaW5nIiwiZGVzY3JpcHRpb24iOiJFbnRlciBHSVRDT0RFX0FDQ0VTU19UT0tFTiIsInBhc3N3b3JkIjp0cnVlfV19) [![Install in VS Code](https://img.shields.io/badge/Install_in-VS_Code-0098FF?logo=visualstudiocode&logoColor=white)](https://vscode.dev/redirect/mcp/install?name=GitCode%20API&config=%7B%22command%22%3A%22uvx%22%2C%22args%22%3A%5B%22--from%22%2C%22gitcode-api%5Bmcp%5D%22%2C%22gitcode-api%22%2C%22serve%22%5D%2C%22env%22%3A%7B%22GITCODE_ACCESS_TOKEN%22%3A%22%24%7Binput%3Agitcode_access_token%7D%22%7D%2C%22inputs%22%3A%5B%7B%22id%22%3A%22gitcode_access_token%22%2C%22type%22%3A%22promptString%22%2C%22description%22%3A%22Enter%20GITCODE_ACCESS_TOKEN%22%2C%22password%22%3Atrue%7D%5D%7D)
 [![GitHub Badge](https://img.shields.io/badge/github-repo-blue?logo=github&link=https%3A%2F%2Fgithub.com%2FTrenza1ore%2FGitCode-API)](https://github.com/Trenza1ore/GitCode-API) [![GitCode Badge](https://img.shields.io/badge/gitcode-repo-brown?logo=gitcode&link=https%3A%2F%2Fgitcode.com%2FSushiNinja%2FGitCode-API)](https://gitcode.com/SushiNinja/GitCode-API)
 
@@ -12,6 +12,7 @@
 
 - Community project for developers who want a practical GitCode Python library.
 - Sync and async clients with a consistent API surface.
+- Convenient methods not offered by REST API directly: such as fetching Issue and PR templates.
 - Resource groups such as `client.repos`, `client.pulls`, and `client.users`.
 - Repository defaults via `owner=` and `repo=` on the client.
 - Sphinx docs plus a mirrored GitCode REST API reference in `docs/`.
@@ -116,6 +117,21 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
+### Convert typed return objects to dicts with `as_dict`
+
+Response values are typed `APIObject` subclasses. For serialization or code that expects built-in `dict`, import `as_dict` from the package root: pass a single model to get a `dict`, or pass a list (for example from `client.pulls.list(...)`) to get `list[dict]`. This mirrors the idea of `dataclasses.asdict` but uses each model’s `to_dict()` method. Use `deep_copy=True` when you need detached deep copies.
+
+```python
+from gitcode_api import GitCode, as_dict
+
+client = GitCode(owner="SushiNinja")
+pulls = client.pulls.list_templates(repo="GitCode-API")
+payload = as_dict(pulls)  # list[dict]
+
+repo = client.repos.get(repo="GitCode-API")
+meta = as_dict(repo)  # dict
+```
+
 ### Context managers
 
 `GitCode` and `AsyncGitCode` (and the lower-level `SyncAPIClient` / `AsyncAPIClient`) support `with` / `async with`. Leaving the block calls `close()` / `await close()` on the underlying client automatically, including a custom `http_client=` you passed in. `close()` also clears the LRU cache used by each resource group's `method_signature(...)` helper (see the [Available Resources](#available-resources) section).
@@ -317,6 +333,8 @@ Runnable examples live in `examples/`:
 
 - `get_current_user.py`
 - `get_repository_overview.py`
+- `get_issue_templates.py`
+- `get_pull_request_templates.py`
 - `list_pull_requests.py`
 - `async_list_branches.py`
 
@@ -325,6 +343,8 @@ Example scripts load shared configuration from `examples/.env` using `python-dot
 ```bash
 uv run python examples/get_current_user.py
 uv run python examples/get_repository_overview.py
+uv run python examples/get_issue_templates.py
+uv run python examples/get_pull_request_templates.py
 uv run python examples/list_pull_requests.py
 uv run python examples/async_list_branches.py
 ```

{gitcode_api-1.2.13 → gitcode_api-1.2.14}/gitcode_api/__init__.py

@@ -9,6 +9,7 @@ from ._exceptions import (
     GitCodeError,
     GitCodeHTTPStatusError,
 )
+from .utils import as_dict
 
 __version__ = (Path(__file__).parent / "version.txt").read_text().strip()
 
@@ -20,4 +21,5 @@ __all__ = [
     "GitCodeConfigurationError",
     "GitCodeError",
     "GitCodeHTTPStatusError",
+    "as_dict",
 ]

{gitcode_api-1.2.13 → gitcode_api-1.2.14}/gitcode_api/_models.py

@@ -9,7 +9,6 @@ from typing import (
     Mapping,
     MutableMapping,
     Optional,
-    TypedDict,
     TypeVar,
     Union,
     get_args,
@@ -136,60 +135,6 @@ def as_model_list(data: List[Mapping[str, Any]], model_type: type[ModelT]) -> Li
     return [as_model(item, model_type) for item in data]
 
 
-class RepositoryCreateParams(TypedDict, total=False):
-    """Typed fields accepted by repository creation endpoints."""
-
-    name: str
-    description: str
-    has_issues: bool
-    has_wiki: bool
-    auto_init: bool
-    gitignore_template: str
-    license_template: str
-    path: str
-    private: bool
-    public: int
-    default_branch: str
-    homepage: str
-    can_comment: bool
-
-
-class IssueCreateParams(TypedDict, total=False):
-    """Typed fields accepted by issue creation endpoints."""
-
-    title: str
-    body: str
-    assignee: str
-    labels: List[str]
-    milestone: Union[int, str]
-
-
-class PullRequestCreateParams(TypedDict, total=False):
-    """Typed fields accepted by pull request creation endpoints."""
-
-    title: str
-    body: str
-    head: str
-    base: str
-    assignees: List[str]
-    testers: List[str]
-    labels: List[str]
-    draft: bool
-
-
-class WebhookCreateParams(TypedDict, total=False):
-    """Typed fields accepted by webhook creation endpoints."""
-
-    url: str
-    encryption_type: int
-    password: str
-    push_events: bool
-    tag_push_events: bool
-    issues_events: bool
-    note_events: bool
-    merge_requests_events: bool
-
-
 @dataclass(init=False)
 class UserRef(APIObject):
     """Compact user payload embedded in other responses.
@@ -513,6 +458,8 @@ class Repository(APIObject):
     :vartype relation: Optional[str]
     :ivar members: Members returned in the repository payload.
     :vartype members: Optional[List[str]]
+    :ivar parent: Upstream source repository information
+    :vartype parent: Optional[Dict[str, Any]]
     :ivar permission: Permission summary for this object.
     :vartype permission: Optional[RepositoryPermission]
     :ivar enterprise: Enterprise associated with the repository.
@@ -566,6 +513,7 @@ class Repository(APIObject):
     status: Optional[str] = None
     relation: Optional[str] = None
     members: Optional[List[str]] = None
+    parent: Optional[Dict[str, Any]] = None
     permission: Optional[RepositoryPermission] = None
     enterprise: Optional[Union[EnterpriseRef, str]] = None
     issue_template_source: Optional[str] = None
@@ -760,6 +708,31 @@ class ContentObject(APIObject):
     _links: Optional[ContentLinks] = None
 
 
+@dataclass(init=False)
+class RepositoryGitCodeTemplate(APIObject):
+    """Metadata for a ``.gitcode`` issue or pull request template file.
+
+    Returned by :meth:`~gitcode_api.resources.collaboration.IssuesResource.list_templates`
+    and :meth:`~gitcode_api.resources.collaboration.PullsResource.list_templates`. Use
+    :meth:`~gitcode_api.resources.collaboration.IssuesResource.get_template` or
+    :meth:`~gitcode_api.resources.collaboration.PullsResource.get_template` to load the body.
+
+    :ivar path: Repository-relative path (under ``.gitcode/``).
+    :vartype path: Optional[str]
+    :ivar sha: Object SHA for the file.
+    :vartype sha: Optional[str]
+    :ivar template_owner: Owner path of the repository the template was resolved from.
+    :vartype template_owner: Optional[str]
+    :ivar template_repo: Repository name the template was resolved from.
+    :vartype template_repo: Optional[str]
+    """
+
+    path: Optional[str] = None
+    sha: Optional[str] = None
+    template_owner: Optional[str] = None
+    template_repo: Optional[str] = None
+
+
 @dataclass(init=False)
 class CommitIdentity(APIObject):
     """Commit author/committer identity.

{gitcode_api-1.2.13 → gitcode_api-1.2.14}/gitcode_api/llm/openai.py

@@ -75,6 +75,7 @@ class GitCodeOpenAITool(GitCodeLLMTool):
         return self.tool
 
     async def __async_call__(self, *args, **kwargs) -> str:
+        """Invoke the configured async tool callable."""
         result = await super().__async_call__(*args, **kwargs)
         return json.dumps(result, ensure_ascii=False, indent=self.indent)