gitcode-api 1.2.0__tar.gz → 1.2.1__tar.gz

{gitcode_api-1.2.0 → gitcode_api-1.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitcode-api
-Version: 1.2.0
+Version: 1.2.1
 Summary: Easy to use Python SDK for the GitCode REST API, community-maintained.
 Author-email: Hugo Huang <hugo@hugohuang.com>
 License-Expression: MIT
@@ -120,7 +120,7 @@ asyncio.run(main())
 
 ### 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.
+`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).
 
 ```python
 from gitcode_api import GitCode
@@ -151,16 +151,13 @@ from gitcode_api import GitCode
 
 client = GitCode(owner="SushiNinja", repo="GitCode-API")
 
-try:
-    pull = client.pulls.create(
-        title="Add feature",
-        head="feature-branch",
-        base="main",
-        body="Implements the new flow.",
-    )
-    print(pull.number)
-finally:
-    client.close()
+pull = client.pulls.create(
+    title="Add feature",
+    head="feature-branch",
+    base="main",
+    body="Implements the new flow.",
+)
+print(pull.number)
 ```
 
 Get the authenticated user:
@@ -170,11 +167,8 @@ from gitcode_api import GitCode
 
 client = GitCode()
 
-try:
-    user = client.users.me()
-    print(user.login)
-finally:
-    client.close()
+user = client.users.me()
+print(user.login)
 ```
 
 Search repositories:
@@ -184,12 +178,9 @@ from gitcode_api import GitCode
 
 client = GitCode()
 
-try:
-    repos = client.search.repositories(q="sdk language:python", per_page=10)
-    for repo in repos:
-        print(repo.full_name)
-finally:
-    client.close()
+repos = client.search.repositories(q="sdk language:python", per_page=10)
+for repo in repos:
+    print(repo.full_name)
 ```
 
 ## Available Resources

{gitcode_api-1.2.0 → gitcode_api-1.2.1}/README.md

@@ -93,7 +93,7 @@ asyncio.run(main())
 
 ### 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.
+`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).
 
 ```python
 from gitcode_api import GitCode
@@ -124,16 +124,13 @@ from gitcode_api import GitCode
 
 client = GitCode(owner="SushiNinja", repo="GitCode-API")
 
-try:
-    pull = client.pulls.create(
-        title="Add feature",
-        head="feature-branch",
-        base="main",
-        body="Implements the new flow.",
-    )
-    print(pull.number)
-finally:
-    client.close()
+pull = client.pulls.create(
+    title="Add feature",
+    head="feature-branch",
+    base="main",
+    body="Implements the new flow.",
+)
+print(pull.number)
 ```
 
 Get the authenticated user:
@@ -143,11 +140,8 @@ from gitcode_api import GitCode
 
 client = GitCode()
 
-try:
-    user = client.users.me()
-    print(user.login)
-finally:
-    client.close()
+user = client.users.me()
+print(user.login)
 ```
 
 Search repositories:
@@ -157,12 +151,9 @@ from gitcode_api import GitCode
 
 client = GitCode()
 
-try:
-    repos = client.search.repositories(q="sdk language:python", per_page=10)
-    for repo in repos:
-        print(repo.full_name)
-finally:
-    client.close()
+repos = client.search.repositories(q="sdk language:python", per_page=10)
+for repo in repos:
+    print(repo.full_name)
 ```
 
 ## Available Resources

{gitcode_api-1.2.0 → gitcode_api-1.2.1}/gitcode_api/__main__.py

@@ -1,3 +1,5 @@
+"""Run the package CLI via ``python -m gitcode_api``."""
+
 from .cli import main
 
 if __name__ == "__main__":

{gitcode_api-1.2.0 → gitcode_api-1.2.1}/gitcode_api/_base_resource.py

@@ -7,7 +7,7 @@ _DATA_MODEL_PATH = "gitcode_api._models."
 
 
 class BaseResource:
-    """Resource group base class"""
+    """Resource group base class."""
 
     def __del__(self) -> None:
         """Attempt to clear the lru cache."""

{gitcode_api-1.2.0 → gitcode_api-1.2.1}/gitcode_api/_client.py

@@ -144,6 +144,7 @@ class GitCode(SyncAPIClient):
         self.oauth = OAuthResource(self)
 
     def __enter__(self) -> "GitCode":
+        """Enter synchronous context and return this client."""
         return self
 
 
@@ -246,4 +247,5 @@ class AsyncGitCode(AsyncAPIClient):
         self.oauth = AsyncOAuthResource(self)
 
     async def __aenter__(self) -> "AsyncGitCode":
+        """Enter asynchronous context and return this client."""
         return self

{gitcode_api-1.2.0 → gitcode_api-1.2.1}/gitcode_api/_models.py

@@ -73,6 +73,7 @@ class APIObject(Mapping[str, Any]):
     data: MutableMapping[str, Any] = field(init=False, repr=False)
 
     def __init__(self, data: Mapping[str, Any]):
+        """Initialize from API response data."""
         payload = dict(data)
         object.__setattr__(self, "data", payload)
         type_hints = get_type_hints(self.__class__)
@@ -95,24 +96,30 @@ class APIObject(Mapping[str, Any]):
             object.__setattr__(self, model_field.name, value)
 
     def __getitem__(self, key: str) -> Any:
+        """Return the value for ``key`` from the backing mapping."""
         return _wrap_value(self.data[key])
 
     def __iter__(self) -> Iterator[str]:
+        """Iterate keys of the backing mapping."""
         return iter(self.data)
 
     def __len__(self) -> int:
+        """Return the number of keys in the backing mapping."""
         return len(self.data)
 
     def __getattr__(self, name: str) -> Any:
+        """Resolve unknown attributes from the backing mapping."""
         try:
             return _wrap_value(self.data[name])
         except KeyError as exc:
             raise AttributeError(name) from exc
 
     def get(self, key: str, default: Any = None) -> Any:
+        """Return the value for ``key``, or ``default`` if missing."""
         return _wrap_value(self.data.get(key, default))
 
     def to_dict(self) -> Dict[str, Any]:
+        """Return a shallow copy of the backing mapping."""
         return dict(self.data)
 
 

{gitcode_api-1.2.0 → gitcode_api-1.2.1}/gitcode_api/cli.py

@@ -174,7 +174,7 @@ def _write_output(value: Any, *, output_file: Optional[str], compact: bool) -> N
 
 
 def _invocation_parent_parser() -> argparse.ArgumentParser:
-    """Flags for real API calls (attached only to leaf METHOD parsers, not top-level usage)."""
+    """Parser with flags for real API calls (attached only to leaf METHOD parsers, not top-level usage)."""
     parser = argparse.ArgumentParser(add_help=False)
     parser.add_argument("--api-key", help=f"GitCode access token. Defaults to {DEFAULT_TOKEN_ENV}.")
     parser.add_argument("--owner", help="Default repository owner.")
@@ -191,6 +191,7 @@ def _root_banner() -> str:
 
 
 def build_parser() -> argparse.ArgumentParser:
+    """Build main parser."""
     common = _invocation_parent_parser()
     epilog = """\
 Examples:
@@ -334,6 +335,7 @@ def _collect_kwargs(args: argparse.Namespace, method: Any) -> dict[str, Any]:
 
 
 def main(argv: Optional[Sequence[str]] = None) -> int:
+    """CLI entry point."""
     parser = build_parser()
     effective = list(sys.argv[1:] if argv is None else argv)
     if not effective:

gitcode_api-1.2.1/gitcode_api/version.txt

@@ -0,0 +1 @@
+1.2.1

{gitcode_api-1.2.0 → gitcode_api-1.2.1}/gitcode_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitcode-api
-Version: 1.2.0
+Version: 1.2.1
 Summary: Easy to use Python SDK for the GitCode REST API, community-maintained.
 Author-email: Hugo Huang <hugo@hugohuang.com>
 License-Expression: MIT
@@ -120,7 +120,7 @@ asyncio.run(main())
 
 ### 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.
+`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).
 
 ```python
 from gitcode_api import GitCode
@@ -151,16 +151,13 @@ from gitcode_api import GitCode
 
 client = GitCode(owner="SushiNinja", repo="GitCode-API")
 
-try:
-    pull = client.pulls.create(
-        title="Add feature",
-        head="feature-branch",
-        base="main",
-        body="Implements the new flow.",
-    )
-    print(pull.number)
-finally:
-    client.close()
+pull = client.pulls.create(
+    title="Add feature",
+    head="feature-branch",
+    base="main",
+    body="Implements the new flow.",
+)
+print(pull.number)
 ```
 
 Get the authenticated user:
@@ -170,11 +167,8 @@ from gitcode_api import GitCode
 
 client = GitCode()
 
-try:
-    user = client.users.me()
-    print(user.login)
-finally:
-    client.close()
+user = client.users.me()
+print(user.login)
 ```
 
 Search repositories:
@@ -184,12 +178,9 @@ from gitcode_api import GitCode
 
 client = GitCode()
 
-try:
-    repos = client.search.repositories(q="sdk language:python", per_page=10)
-    for repo in repos:
-        print(repo.full_name)
-finally:
-    client.close()
+repos = client.search.repositories(q="sdk language:python", per_page=10)
+for repo in repos:
+    print(repo.full_name)
 ```
 
 ## Available Resources

{gitcode_api-1.2.0 → gitcode_api-1.2.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitcode-api"
-version = "1.2.0"
+version = "1.2.1"
 description = "Easy to use Python SDK for the GitCode REST API, community-maintained."
 keywords = ["gitcode", "git", "devops", "api", "sdk", "python", "httpx", "client"]
 readme = "README.md"
@@ -37,6 +37,7 @@ docs = [
     "sphinx",
     "sphinx-rtd-theme",
     "beautifulsoup4",
+    "myst-parser>=3.0.1,<4",
 ]
 
 # Formatting
@@ -73,6 +74,9 @@ addopts = ["-v"]
 line-length = 120
 target-version = "py39"
 
+[tool.ruff.pydocstyle]
+convention = "pep257"
+
 [tool.pylint.MAIN]
 ignore-paths = ["^(examples|tests|docs|scripts)/.*"]
 py-version = "3.9"

gitcode_api-1.2.0/gitcode_api/version.txt

@@ -1 +0,0 @@
-1.2.0