gitcode-api 1.1.1__py3-none-any.whl → 1.1.2__py3-none-any.whl

gitcode_api/_base_client.py

@@ -5,7 +5,7 @@ payload cleanup, and response parsing for both sync and async clients.
 """
 
 import os
-from typing import Any, Dict, Optional, Tuple, Union
+from typing import Any, Callable, Dict, Optional, Tuple, Union
 from urllib.parse import quote
 
 import httpx
@@ -30,6 +30,7 @@ class BaseGitCodeClient:
     :param repo: Default repository name for repository-scoped calls.
     :param base_url: Base URL for the GitCode REST API.
     :param timeout: Request timeout in seconds.
+    :param decrypt: Optional decryption function for encrypted access token.
     """
 
     def __init__(
@@ -40,20 +41,23 @@ class BaseGitCodeClient:
         repo: Optional[str] = None,
         base_url: str = DEFAULT_BASE_URL,
         timeout: Optional[float] = None,
+        decrypt: Optional[Callable] = None,
     ) -> None:
         """Store client configuration and resolve authentication."""
-        self.api_key = self._resolve_api_key(api_key)
+        self.api_key = self._resolve_api_key(api_key, decrypt)
         self.owner = owner
         self.repo = repo
         self.base_url = base_url.rstrip("/")
         self.timeout = timeout if timeout is not None else DEFAULT_TIMEOUT
 
-    def _resolve_api_key(self, api_key: Optional[str]) -> str:
+    def _resolve_api_key(self, api_key: Optional[str], decrypt: Optional[Callable] = None) -> str:
         """Resolve the access token from an argument or environment variable."""
         token = api_key or os.getenv(DEFAULT_TOKEN_ENV)
+        if callable(decrypt):
+            token = decrypt(token)
         if not token:
             raise GitCodeConfigurationError("No API key provided. Pass api_key=... or set GITCODE_ACCESS_TOKEN.")
-        return token
+        return str(token)
 
     def _resolve_repo_context(
         self,
@@ -187,6 +191,7 @@ class SyncAPIClient(BaseGitCodeClient):
     :param base_url: Base URL for the GitCode REST API.
     :param timeout: Request timeout in seconds.
     :param http_client: Optional pre-configured ``httpx.Client`` instance.
+    :param decrypt: Optional decryption function for encrypted access token.
     """
 
     def __init__(
@@ -198,9 +203,10 @@ class SyncAPIClient(BaseGitCodeClient):
         base_url: str = DEFAULT_BASE_URL,
         timeout: Optional[float] = None,
         http_client: Optional[httpx.Client] = None,
+        decrypt: Optional[Callable] = None,
     ) -> None:
         """Create or reuse an ``httpx.Client`` for synchronous requests."""
-        super().__init__(api_key=api_key, owner=owner, repo=repo, base_url=base_url, timeout=timeout)
+        super().__init__(api_key=api_key, owner=owner, repo=repo, base_url=base_url, timeout=timeout, decrypt=decrypt)
         self._owns_client = http_client is None
         self._client = http_client or httpx.Client(timeout=self.timeout)
 
@@ -238,9 +244,8 @@ class SyncAPIClient(BaseGitCodeClient):
         return self._parse_response(response, raw=raw)
 
     def close(self) -> None:
-        """Close the underlying HTTP client if this instance created it."""
-        if self._owns_client:
-            self._client.close()
+        """Close the underlying HTTP client."""
+        self._client.close()
 
     def __enter__(self) -> "SyncAPIClient":
         """Enter a context manager and return the client instance."""
@@ -260,6 +265,7 @@ class AsyncAPIClient(BaseGitCodeClient):
     :param base_url: Base URL for the GitCode REST API.
     :param timeout: Request timeout in seconds.
     :param http_client: Optional pre-configured ``httpx.AsyncClient`` instance.
+    :param decrypt: Optional decryption function for encrypted access token.
     """
 
     def __init__(
@@ -271,9 +277,10 @@ class AsyncAPIClient(BaseGitCodeClient):
         base_url: str = DEFAULT_BASE_URL,
         timeout: Optional[float] = None,
         http_client: Optional[httpx.AsyncClient] = None,
+        decrypt: Optional[Callable] = None,
     ) -> None:
         """Create or reuse an ``httpx.AsyncClient`` for asynchronous requests."""
-        super().__init__(api_key=api_key, owner=owner, repo=repo, base_url=base_url, timeout=timeout)
+        super().__init__(api_key=api_key, owner=owner, repo=repo, base_url=base_url, timeout=timeout, decrypt=decrypt)
         self._owns_client = http_client is None
         self._client = http_client or httpx.AsyncClient(timeout=self.timeout)
 
@@ -311,9 +318,8 @@ class AsyncAPIClient(BaseGitCodeClient):
         return self._parse_response(response, raw=raw)
 
     async def close(self) -> None:
-        """Close the underlying async HTTP client if this instance created it."""
-        if self._owns_client:
-            await self._client.aclose()
+        """Close the underlying async HTTP client."""
+        await self._client.aclose()
 
     async def __aenter__(self) -> "AsyncAPIClient":
         """Enter an async context manager and return the client instance."""

gitcode_api/_client.py

@@ -4,7 +4,7 @@ These client classes expose grouped resource helpers that mirror the
 published GitCode REST API documentation.
 """
 
-from typing import Optional
+from typing import Callable, Optional
 
 import httpx
 
@@ -54,6 +54,7 @@ class GitCode(SyncAPIClient):
     :param base_url: Base URL for the GitCode REST API.
     :param timeout: Request timeout in seconds.
     :param http_client: Optional pre-configured ``httpx.Client`` instance.
+    :param decrypt: Optional decryption function for encrypted access token.
     """
 
     repos: ReposResource
@@ -113,6 +114,7 @@ class GitCode(SyncAPIClient):
         base_url: str = DEFAULT_BASE_URL,
         timeout: Optional[float] = None,
         http_client: Optional[httpx.Client] = None,
+        decrypt: Optional[Callable] = None,
     ) -> None:
         """Create a synchronous client and attach resource groups."""
         super().__init__(
@@ -122,6 +124,7 @@ class GitCode(SyncAPIClient):
             base_url=base_url,
             timeout=timeout,
             http_client=http_client,
+            decrypt=decrypt,
         )
         self.repos = ReposResource(self)
         self.contents = RepoContentsResource(self)
@@ -153,6 +156,7 @@ class AsyncGitCode(AsyncAPIClient):
     :param base_url: Base URL for the GitCode REST API.
     :param timeout: Request timeout in seconds.
     :param http_client: Optional pre-configured ``httpx.AsyncClient`` instance.
+    :param decrypt: Optional decryption function for encrypted access token.
     """
 
     repos: AsyncReposResource
@@ -212,6 +216,7 @@ class AsyncGitCode(AsyncAPIClient):
         base_url: str = DEFAULT_BASE_URL,
         timeout: Optional[float] = None,
         http_client: Optional[httpx.AsyncClient] = None,
+        decrypt: Optional[Callable] = None,
     ) -> None:
         """Create an asynchronous client and attach resource groups."""
         super().__init__(
@@ -221,6 +226,7 @@ class AsyncGitCode(AsyncAPIClient):
             base_url=base_url,
             timeout=timeout,
             http_client=http_client,
+            decrypt=decrypt,
         )
         self.repos = AsyncReposResource(self)
         self.contents = AsyncRepoContentsResource(self)

gitcode_api/version.txt

@@ -0,0 +1 @@
+1.1.2

{gitcode_api-1.1.1.dist-info → gitcode_api-1.1.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitcode-api
-Version: 1.1.1
+Version: 1.1.2
 Summary: Easy to use Python SDK for the GitCode REST API, community-maintained.
 Author-email: Hugo Huang <hugo@hugohuang.com>
 License-Expression: MIT
@@ -27,9 +27,9 @@ 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) ![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)](https://pypi.org/project/gitcode-api) [![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) [![PyPI Downloads](https://static.pepy.tech/personalized-badge/gitcode-api?period=total&units=INTERNATIONAL_SYSTEM&left_color=GRAY&right_color=RED&left_text=downloads)](https://pepy.tech/projects/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)
+[![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)](https://gitcode-api.readthedocs.io) [![中文README](https://img.shields.io/badge/%E4%B8%AD%E6%96%87-README-brown?style=for-the-badge&logo=googledocs&link=README.zh.md)](README.zh.md) [![English README](https://img.shields.io/badge/English-README-blue?style=for-the-badge&logo=googledocs&link=README.md)](README.md)
 
 `gitcode-api` is a community-maintained Python SDK for the GitCode REST API. It provides easy-to-use synchronous and asynchronous clients, repository-scoped helpers, and lightweight response models so you can work with GitCode from Python without hand-writing raw HTTP requests.
 
@@ -57,6 +57,20 @@ Pass `api_key=` directly, or set `GITCODE_ACCESS_TOKEN` in your environment:
 export GITCODE_ACCESS_TOKEN="your-token"
 ```
 
+If your token is stored in encrypted form, pass `decrypt=` to decode either an
+encrypted `api_key=` value or an encrypted `GITCODE_ACCESS_TOKEN` value before
+the client uses it.
+
+```python
+from gitcode_api import GitCode
+from trusted_library import decrypt_token
+
+client = GitCode(
+    api_key="encrypted-token",
+    decrypt=decrypt_token,
+)
+```
+
 ## Quick Start
 
 ### Sync client
@@ -69,40 +83,31 @@ client = GitCode(
     repo="GitCode-API",
 )
 
-try:
-    repo = client.repos.get()
-    branches = client.branches.list(per_page=5)
+repo = client.repos.get()
+branches = client.branches.list(per_page=5)
 
-    print(repo.full_name)
-    for branch in branches:
-        print(branch.name)
-finally:
-    client.close()
+print(repo.full_name)
+for branch in branches:
+    print(branch.name)
 ```
 
 ### Async client
 
 ```python
 import asyncio
-
 from gitcode_api import AsyncGitCode
 
-
 async def main() -> None:
     client = AsyncGitCode(owner="SushiNinja", repo="GitCode-API")
-    try:
-        pulls = await client.pulls.list(state="open", per_page=20)
-        print(len(pulls))
-    finally:
-        await client.close()
-
+    pulls = await client.pulls.list(state="open", per_page=20)
+    print(len(pulls))
 
 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.
+`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.
 
 ```python
 from gitcode_api import GitCode
@@ -114,21 +119,16 @@ with GitCode(owner="SushiNinja", repo="GitCode-API") as client:
 
 ```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.1.1.dist-info → gitcode_api-1.1.2.dist-info}/RECORD

@@ -1,16 +1,17 @@
 gitcode_api/__init__.py,sha256=NvLp28D9brVbmv2ROSZ8mxKDuIamE9xeutBKGl9pra8,497
-gitcode_api/_base_client.py,sha256=KWe-gP7CGLhG_DtxPclbbJQVXOj6hjtQgAjoCzoUCmo,12496
-gitcode_api/_client.py,sha256=1bVngWEkjKoOOODIpvJNlrKS3x1dj-WAUrBW4xncjWY,7819
+gitcode_api/_base_client.py,sha256=1COCZXzSiCe_LNawsOsTNvh0WMh1JW4A5yYgX56HwjY,12894
+gitcode_api/_client.py,sha256=AOpp1P7vdSlMcn0XP3JMPnAKbQMftMO9WMubBGw2LZc,8129
 gitcode_api/_exceptions.py,sha256=T5N8gBGmPSktDkLP5P_hxbzOHw3W378TzxN1xja40pA,1140
 gitcode_api/_models.py,sha256=2bR6Wxc3Ie7iM3UFNY0ThWeNjxFHzDAC-8QFgcgcT_0,108599
+gitcode_api/version.txt,sha256=g9DE-d3AiatY4yLimLYZDyv1kdwiX_XN130F5qhCBhk,5
 gitcode_api/resources/__init__.py,sha256=nsCKW0bFDZ5ombJZxLThmO82sOuF7o4OKUMRkAmwbwk,1725
 gitcode_api/resources/_shared.py,sha256=EB9fr4eQUc9IOdZCn4AoI946SJYCNVAtOOHEo_OzJAQ,5317
 gitcode_api/resources/account.py,sha256=mnc2p7wI-nBnHFNdWPNiHfmZpT6d3RDQC777gewtm4M,38801
 gitcode_api/resources/collaboration.py,sha256=26rQCeayZfUQ_6dIdl5HOGXnYkMLx8V7XsF_Wi-4Qt4,101417
 gitcode_api/resources/misc.py,sha256=guDwh4cxbTVsSa7EivaYM3bKMJ8_Op4KucGbKEoayKE,22412
 gitcode_api/resources/repositories.py,sha256=EAK2znZhEsgVUu-NDEQslSEEYJzvb-kHuh4mW57y6sc,78178
-gitcode_api-1.1.1.dist-info/licenses/LICENSE,sha256=gOACXuWhMu6PJKVLr9RQbxX3HULnZIGNXCaMFJIXhoA,1067
-gitcode_api-1.1.1.dist-info/METADATA,sha256=FXeDlnMlvn12FHZV7jYTkAYNjG34aCVBMwhhSNWh7Ug,6778
-gitcode_api-1.1.1.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-gitcode_api-1.1.1.dist-info/top_level.txt,sha256=gIlg0ptyOUHJT64ajOjWIhRPYgIQnMIvnhhnesw9fxU,12
-gitcode_api-1.1.1.dist-info/RECORD,,
+gitcode_api-1.1.2.dist-info/licenses/LICENSE,sha256=gOACXuWhMu6PJKVLr9RQbxX3HULnZIGNXCaMFJIXhoA,1067
+gitcode_api-1.1.2.dist-info/METADATA,sha256=0N2qnZGKbZf_4jxrfQwWDd2daaRhdA3GRw0OqC75C0o,7151
+gitcode_api-1.1.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+gitcode_api-1.1.2.dist-info/top_level.txt,sha256=gIlg0ptyOUHJT64ajOjWIhRPYgIQnMIvnhhnesw9fxU,12
+gitcode_api-1.1.2.dist-info/RECORD,,