gitcode-api 1.0.3__tar.gz → 1.1.0__tar.gz

{gitcode_api-1.0.3 → gitcode_api-1.1.0}/PKG-INFO

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: gitcode-api
-Version: 1.0.3
+Version: 1.1.0
 Summary: Easy to use Python SDK for the GitCode REST API, community-maintained.
 Author-email: Hugo Huang <hugo@hugohuang.com>
 License-Expression: MIT
-Project-URL: github, https://github.com/Trenza1ore/GitCode-API
+Project-URL: documentation, https://gitcode-api.readthedocs.io
 Project-URL: gitcode, https://gitcode.com/SushiNinja/GitCode-API
-Project-URL: documentation, https://gitcode-api.readthedocs.io/en/latest/index.html
+Project-URL: github, https://github.com/Trenza1ore/GitCode-API
 Keywords: gitcode,git,devops,api,sdk,python,httpx,client
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
@@ -23,12 +23,11 @@ Requires-Python: <4,>=3.9
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: httpx
-Requires-Dist: python-dotenv
 Dynamic: license-file
 
 # GitCode-API
 
-![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api) ![GitHub Badge](https://img.shields.io/badge/github-repo-blue?logo=github&link=https%3A%2F%2Fgithub.com%2FTrenza1ore%2FGitCode-API) ![GitCode Badge](https://img.shields.io/badge/gitcode-repo-brown?logo=gitcode&link=https%3A%2F%2Fgitcode.com%2FSushiNinja%2FGitCode-API) ![PyPI - License](https://img.shields.io/pypi/l/gitcode-api)
+![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api?link=https%3A%2F%2Fpypi.org%2Fproject%2Fgitcode-api%2F) ![GitHub Badge](https://img.shields.io/badge/github-repo-blue?logo=github&link=https%3A%2F%2Fgithub.com%2FTrenza1ore%2FGitCode-API) ![GitCode Badge](https://img.shields.io/badge/gitcode-repo-brown?logo=gitcode&link=https%3A%2F%2Fgitcode.com%2FSushiNinja%2FGitCode-API) ![PyPI - License](https://img.shields.io/pypi/l/gitcode-api)
 
 ![Docs](https://img.shields.io/badge/%E6%96%87%E6%A1%A3-Docs-cyan?style=for-the-badge&logo=readthedocs&link=https%3A%2F%2Fgitcode-api.readthedocs.io%2Fen%2Flatest%2Findex.html) ![中文README](https://img.shields.io/badge/%E4%B8%AD%E6%96%87-README-brown?style=for-the-badge&logo=googledocs&link=README.zh.md) ![English README](https://img.shields.io/badge/English-README-blue?style=for-the-badge&logo=googledocs&link=README.md)
 
@@ -50,18 +49,6 @@ Install from PyPI:
 pip install gitcode-api
 ```
 
-For local development from source:
-
-```bash
-uv sync
-```
-
-Install documentation dependencies:
-
-```bash
-uv sync --group docs
-```
-
 ## Authentication
 
 Pass `api_key=` directly, or set `GITCODE_ACCESS_TOKEN` in your environment:
@@ -113,6 +100,35 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
+### Context managers
+
+`GitCode` and `AsyncGitCode` (and the lower-level `SyncAPIClient` / `AsyncAPIClient`) support `with` / `async with`. When the SDK creates the underlying httpx client for you, leaving the block calls `close()` / `await close()` on that client automatically.
+
+```python
+from gitcode_api import GitCode
+
+with GitCode(owner="SushiNinja", repo="GitCode-API") as client:
+    repo = client.repos.get()
+    print(repo.full_name)
+```
+
+```python
+import asyncio
+
+from gitcode_api import AsyncGitCode
+
+
+async def main() -> None:
+    async with AsyncGitCode(owner="SushiNinja", repo="GitCode-API") as client:
+        pulls = await client.pulls.list(state="open", per_page=20)
+        print(len(pulls))
+
+
+asyncio.run(main())
+```
+
+If you pass a custom `http_client=`, the SDK does not close it; you still own that client’s lifecycle (for example `async with httpx.AsyncClient(...) as http:` plus `AsyncGitCode(http_client=http)`).
+
 ## Common Workflows
 
 Create a pull request:

{gitcode_api-1.0.3 → gitcode_api-1.1.0}/README.md

@@ -1,6 +1,6 @@
 # GitCode-API
 
-![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api) ![GitHub Badge](https://img.shields.io/badge/github-repo-blue?logo=github&link=https%3A%2F%2Fgithub.com%2FTrenza1ore%2FGitCode-API) ![GitCode Badge](https://img.shields.io/badge/gitcode-repo-brown?logo=gitcode&link=https%3A%2F%2Fgitcode.com%2FSushiNinja%2FGitCode-API) ![PyPI - License](https://img.shields.io/pypi/l/gitcode-api)
+![PyPI - Version](https://img.shields.io/pypi/v/gitcode-api?link=https%3A%2F%2Fpypi.org%2Fproject%2Fgitcode-api%2F) ![GitHub Badge](https://img.shields.io/badge/github-repo-blue?logo=github&link=https%3A%2F%2Fgithub.com%2FTrenza1ore%2FGitCode-API) ![GitCode Badge](https://img.shields.io/badge/gitcode-repo-brown?logo=gitcode&link=https%3A%2F%2Fgitcode.com%2FSushiNinja%2FGitCode-API) ![PyPI - License](https://img.shields.io/pypi/l/gitcode-api)
 
 ![Docs](https://img.shields.io/badge/%E6%96%87%E6%A1%A3-Docs-cyan?style=for-the-badge&logo=readthedocs&link=https%3A%2F%2Fgitcode-api.readthedocs.io%2Fen%2Flatest%2Findex.html) ![中文README](https://img.shields.io/badge/%E4%B8%AD%E6%96%87-README-brown?style=for-the-badge&logo=googledocs&link=README.zh.md) ![English README](https://img.shields.io/badge/English-README-blue?style=for-the-badge&logo=googledocs&link=README.md)
 
@@ -22,18 +22,6 @@ Install from PyPI:
 pip install gitcode-api
 ```
 
-For local development from source:
-
-```bash
-uv sync
-```
-
-Install documentation dependencies:
-
-```bash
-uv sync --group docs
-```
-
 ## Authentication
 
 Pass `api_key=` directly, or set `GITCODE_ACCESS_TOKEN` in your environment:
@@ -85,6 +73,35 @@ async def main() -> None:
 asyncio.run(main())
 ```
 
+### Context managers
+
+`GitCode` and `AsyncGitCode` (and the lower-level `SyncAPIClient` / `AsyncAPIClient`) support `with` / `async with`. When the SDK creates the underlying httpx client for you, leaving the block calls `close()` / `await close()` on that client automatically.
+
+```python
+from gitcode_api import GitCode
+
+with GitCode(owner="SushiNinja", repo="GitCode-API") as client:
+    repo = client.repos.get()
+    print(repo.full_name)
+```
+
+```python
+import asyncio
+
+from gitcode_api import AsyncGitCode
+
+
+async def main() -> None:
+    async with AsyncGitCode(owner="SushiNinja", repo="GitCode-API") as client:
+        pulls = await client.pulls.list(state="open", per_page=20)
+        print(len(pulls))
+
+
+asyncio.run(main())
+```
+
+If you pass a custom `http_client=`, the SDK does not close it; you still own that client’s lifecycle (for example `async with httpx.AsyncClient(...) as http:` plus `AsyncGitCode(http_client=http)`).
+
 ## Common Workflows
 
 Create a pull request:

{gitcode_api-1.0.3 → gitcode_api-1.1.0}/gitcode_api/resources/_shared.py

@@ -23,21 +23,51 @@ class SyncResource:
         data: Optional[Dict[str, Any]] = None,
         raw: bool = False,
     ) -> Any:
-        """Dispatch a low-level request through the owning client."""
+        """Dispatch a low-level request through the owning client.
+
+        :param method: HTTP verb (for example ``GET`` or ``POST``).
+        :param path: Absolute or root-relative URL path.
+        :param params: Optional query string parameters.
+        :param json: Optional JSON-serializable request body.
+        :param data: Optional form or body fields.
+        :param raw: When ``True``, return the raw response body (for example bytes).
+        :returns: Parsed JSON, raw body, or other value from the client.
+        """
         return self._client.request(method, path, params=params, json=json, data=data, raw=raw)
 
     def _model(self, method: str, path: str, model_type: type[ModelT], **kwargs: Any) -> ModelT:
-        """Send a request and wrap a JSON object in ``model_type``."""
+        """Send a request and wrap a JSON object in ``model_type``.
+
+        :param method: HTTP verb.
+        :param path: Request path.
+        :param model_type: Model class for the top-level JSON object.
+        :param kwargs: Forwarded to :meth:`_request` (``params``, ``json``, ``data``, ``raw``, etc.).
+        :returns: An instance of ``model_type``.
+        """
         data = self._request(method, path, **kwargs)
         return as_model(data, model_type)
 
     def _models(self, method: str, path: str, model_type: type[ModelT], **kwargs: Any) -> List[ModelT]:
-        """Send a request and wrap a JSON array in ``model_type`` instances."""
+        """Send a request and wrap a JSON array in ``model_type`` instances.
+
+        :param method: HTTP verb.
+        :param path: Request path.
+        :param model_type: Model class for each element of the JSON array.
+        :param kwargs: Forwarded to :meth:`_request`.
+        :returns: A list of ``model_type`` instances.
+        """
         data = self._request(method, path, **kwargs)
         return as_model_list(data, model_type)
 
     def _maybe_model(self, method: str, path: str, model_type: type[ModelT], **kwargs: Any) -> Union[ModelT, APIObject]:
-        """Wrap dict responses as models and scalar responses as ``APIObject``."""
+        """Wrap dict responses as models and scalar responses as ``APIObject``.
+
+        :param method: HTTP verb.
+        :param path: Request path.
+        :param model_type: Model class when the response is a JSON object.
+        :param kwargs: Forwarded to :meth:`_request`.
+        :returns: ``model_type`` for dict bodies; otherwise ``APIObject`` wrapping a ``value`` field.
+        """
         data = self._request(method, path, **kwargs)
         if isinstance(data, dict):
             return as_model(data, model_type)
@@ -61,15 +91,38 @@ class AsyncResource:
         data: Optional[Dict[str, Any]] = None,
         raw: bool = False,
     ) -> Any:
-        """Dispatch a low-level async request through the owning client."""
+        """Dispatch a low-level async request through the owning client.
+
+        :param method: HTTP verb (for example ``GET`` or ``POST``).
+        :param path: Absolute or root-relative URL path.
+        :param params: Optional query string parameters.
+        :param json: Optional JSON-serializable request body.
+        :param data: Optional form or body fields.
+        :param raw: When ``True``, return the raw response body (for example bytes).
+        :returns: Parsed JSON, raw body, or other value from the client.
+        """
         return await self._client.request(method, path, params=params, json=json, data=data, raw=raw)
 
     async def _model(self, method: str, path: str, model_type: type[ModelT], **kwargs: Any) -> ModelT:
-        """Send a request and wrap a JSON object in ``model_type``."""
+        """Send a request and wrap a JSON object in ``model_type``.
+
+        :param method: HTTP verb.
+        :param path: Request path.
+        :param model_type: Model class for the top-level JSON object.
+        :param kwargs: Forwarded to :meth:`_request`.
+        :returns: An instance of ``model_type``.
+        """
         data = await self._request(method, path, **kwargs)
         return as_model(data, model_type)
 
     async def _models(self, method: str, path: str, model_type: type[ModelT], **kwargs: Any) -> List[ModelT]:
-        """Send a request and wrap a JSON array in ``model_type`` instances."""
+        """Send a request and wrap a JSON array in ``model_type`` instances.
+
+        :param method: HTTP verb.
+        :param path: Request path.
+        :param model_type: Model class for each element of the JSON array.
+        :param kwargs: Forwarded to :meth:`_request`.
+        :returns: A list of ``model_type`` instances.
+        """
         data = await self._request(method, path, **kwargs)
         return as_model_list(data, model_type)