gitcode-api 1.1.2__tar.gz → 1.1.3__tar.gz

{gitcode_api-1.1.2 → gitcode_api-1.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitcode-api
-Version: 1.1.2
+Version: 1.1.3
 Summary: Easy to use Python SDK for the GitCode REST API, community-maintained.
 Author-email: Hugo Huang <hugo@hugohuang.com>
 License-Expression: MIT
@@ -46,7 +46,7 @@ Dynamic: license-file
 Install from PyPI:
 
 ```bash
-pip install gitcode-api
+pip install -U gitcode-api
 ```
 
 ## Authentication
@@ -71,6 +71,19 @@ client = GitCode(
 )
 ```
 
+## CLI
+
+After installation, you can invoke the SDK directly from the command line:
+
+```bash
+gitcode-api repos get --api-key "$GITCODE_ACCESS_TOKEN" --owner SushiNinja --repo GitCode-API
+python -m gitcode_api pulls list --api-key "$GITCODE_ACCESS_TOKEN" --owner SushiNinja --repo GitCode-API --state open
+```
+
+Commands mirror the synchronous resource methods on `GitCode`, using the pattern
+`gitcode-api <resource> <method> ...`. For methods that accept extra `**params`
+or `**payload`, pass repeated `--set key=value` flags or `--set-json '{"key": "value"}'`.
+
 ## Quick Start
 
 ### Sync client

{gitcode_api-1.1.2 → gitcode_api-1.1.3}/README.md

@@ -19,7 +19,7 @@
 Install from PyPI:
 
 ```bash
-pip install gitcode-api
+pip install -U gitcode-api
 ```
 
 ## Authentication
@@ -44,6 +44,19 @@ client = GitCode(
 )
 ```
 
+## CLI
+
+After installation, you can invoke the SDK directly from the command line:
+
+```bash
+gitcode-api repos get --api-key "$GITCODE_ACCESS_TOKEN" --owner SushiNinja --repo GitCode-API
+python -m gitcode_api pulls list --api-key "$GITCODE_ACCESS_TOKEN" --owner SushiNinja --repo GitCode-API --state open
+```
+
+Commands mirror the synchronous resource methods on `GitCode`, using the pattern
+`gitcode-api <resource> <method> ...`. For methods that accept extra `**params`
+or `**payload`, pass repeated `--set key=value` flags or `--set-json '{"key": "value"}'`.
+
 ## Quick Start
 
 ### Sync client

gitcode_api-1.1.3/gitcode_api/__main__.py

@@ -0,0 +1,4 @@
+from .cli import main
+
+if __name__ == "__main__":
+    raise SystemExit(main())

gitcode_api-1.1.3/gitcode_api/cli.py

@@ -0,0 +1,255 @@
+"""Command-line interface for the GitCode SDK."""
+
+import argparse
+import inspect
+import json
+import sys
+from collections.abc import Mapping, Sequence
+from pathlib import Path
+from typing import Any, List, Optional, Union, get_args, get_origin
+
+from . import GitCode, __version__
+from ._base_client import DEFAULT_BASE_URL, DEFAULT_TOKEN_ENV
+from ._exceptions import GitCodeError
+from .resources._shared import SyncResource
+
+
+def _unwrap_optional(annotation: Any) -> Any:
+    origin = get_origin(annotation)
+    if origin is Union:
+        args = [arg for arg in get_args(annotation) if arg is not type(None)]
+        if len(args) == 1:
+            return args[0]
+    return annotation
+
+
+def _is_list_annotation(annotation: Any) -> bool:
+    annotation = _unwrap_optional(annotation)
+    return get_origin(annotation) in (list, List)
+
+
+def _list_item_type(annotation: Any) -> Any:
+    annotation = _unwrap_optional(annotation)
+    args = get_args(annotation)
+    if not args:
+        return str
+    item_type = _unwrap_optional(args[0])
+    if item_type in (int, float):
+        return item_type
+    return str
+
+
+def _argument_kwargs(parameter: inspect.Parameter) -> dict[str, Any]:
+    annotation = _unwrap_optional(parameter.annotation)
+    if annotation is bool:
+        return {"action": argparse.BooleanOptionalAction, "default": parameter.default}
+    if _is_list_annotation(parameter.annotation):
+        return {"nargs": "+", "type": _list_item_type(parameter.annotation), "default": None}
+    if annotation in (int, float):
+        return {"type": annotation}
+    return {"type": str}
+
+
+def _first_doc_line(obj: Any) -> str:
+    doc = inspect.getdoc(obj) or ""
+    return doc.splitlines()[0] if doc else ""
+
+
+def _resource_types() -> dict[str, type[SyncResource]]:
+    resources: dict[str, type[SyncResource]] = {}
+    for name, annotation in GitCode.__annotations__.items():
+        if inspect.isclass(annotation) and issubclass(annotation, SyncResource):
+            resources[name] = annotation
+    return resources
+
+
+def _iter_resource_methods(resource_type: type[SyncResource]) -> list[tuple[str, Any]]:
+    methods: list[tuple[str, Any]] = []
+    for name, value in resource_type.__dict__.items():
+        if name.startswith("_") or not inspect.isfunction(value):
+            continue
+        methods.append((name, value))
+    return methods
+
+
+def _kebab_case(value: str) -> str:
+    return value.replace("_", "-")
+
+
+def _load_json_value(raw: str) -> Any:
+    if raw.startswith("@"):
+        return json.loads(Path(raw[1:]).read_text(encoding="utf-8"))
+    return json.loads(raw)
+
+
+def _parse_scalar(raw: str) -> Any:
+    try:
+        return _load_json_value(raw)
+    except (OSError, ValueError, json.JSONDecodeError):
+        return raw
+
+
+def _parse_key_value(raw: str) -> tuple[str, Any]:
+    if "=" not in raw:
+        raise ValueError(f"Expected KEY=VALUE, got: {raw}")
+    key, value = raw.split("=", maxsplit=1)
+    if not key:
+        raise ValueError(f"Expected KEY=VALUE, got: {raw}")
+    return key, _parse_scalar(value)
+
+
+def _to_data(value: Any) -> Any:
+    if hasattr(value, "to_dict") and callable(value.to_dict):
+        return _to_data(value.to_dict())
+    if isinstance(value, Mapping):
+        return {key: _to_data(item) for key, item in value.items()}
+    if isinstance(value, list):
+        return [_to_data(item) for item in value]
+    return value
+
+
+def _write_output(value: Any, *, output_file: Optional[str], compact: bool) -> None:
+    if value is None:
+        return
+    if isinstance(value, bytes):
+        if output_file:
+            Path(output_file).write_bytes(value)
+        else:
+            sys.stdout.buffer.write(value)
+        return
+
+    payload = _to_data(value)
+    if isinstance(payload, str):
+        text = payload
+    else:
+        text = json.dumps(payload, indent=None if compact else 2, ensure_ascii=True, sort_keys=True)
+
+    if output_file:
+        Path(output_file).write_text(text + ("\n" if not text.endswith("\n") else ""), encoding="utf-8")
+    else:
+        print(text)
+
+
+def _global_parent_parser() -> argparse.ArgumentParser:
+    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.")
+    parser.add_argument("--repo", help="Default repository name.")
+    parser.add_argument("--base-url", default=DEFAULT_BASE_URL, help="Base URL for the GitCode REST API.")
+    parser.add_argument("--timeout", type=float, default=None, help="Request timeout in seconds.")
+    parser.add_argument("--output-file", help="Write the response to a file instead of stdout.")
+    parser.add_argument("--compact", action="store_true", help="Print JSON without indentation.")
+    return parser
+
+
+def build_parser() -> argparse.ArgumentParser:
+    common = _global_parent_parser()
+    parser = argparse.ArgumentParser(
+        prog="gitcode-api",
+        description="Invoke any synchronous gitcode-api resource method from the command line.",
+        epilog='Use `--set key=value` and `--set-json \'{"key": "value"}\'` for methods with `**params` or `**payload`.',
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+        parents=[common],
+    )
+    parser.add_argument("--version", action="version", version=f"%(prog)s {__version__}")
+
+    resource_parsers = parser.add_subparsers(dest="resource", required=True)
+    for resource_name, resource_type in _resource_types().items():
+        resource_parser = resource_parsers.add_parser(
+            _kebab_case(resource_name),
+            help=_first_doc_line(resource_type),
+        )
+        method_parsers = resource_parser.add_subparsers(dest="method", required=True)
+
+        for method_name, method in _iter_resource_methods(resource_type):
+            method_parser = method_parsers.add_parser(
+                _kebab_case(method_name),
+                help=_first_doc_line(method),
+                description=inspect.getdoc(method),
+                formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+                parents=[common],
+            )
+            signature = inspect.signature(method)
+            for parameter in signature.parameters.values():
+                if parameter.name == "self":
+                    continue
+                if parameter.kind == inspect.Parameter.VAR_KEYWORD:
+                    method_parser.add_argument(
+                        "--set",
+                        dest="extra_items",
+                        action="append",
+                        default=None,
+                        metavar="KEY=VALUE",
+                        help="Additional keyword arguments for `**params` or `**payload`.",
+                    )
+                    method_parser.add_argument(
+                        "--set-json",
+                        dest="extra_json",
+                        default=None,
+                        metavar="JSON_OR_@FILE",
+                        help="JSON object merged into extra keyword arguments.",
+                    )
+                    continue
+
+                flag = f"--{parameter.name.replace('_', '-')}"
+                if flag in method_parser._option_string_actions:
+                    continue
+                kwargs = _argument_kwargs(parameter)
+                kwargs["dest"] = parameter.name
+                kwargs["required"] = parameter.default is inspect.Signature.empty
+                method_parser.add_argument(flag, **kwargs)
+
+            method_parser.set_defaults(resource_name=resource_name, method_name=method_name)
+
+    return parser
+
+
+def _collect_kwargs(args: argparse.Namespace, method: Any) -> dict[str, Any]:
+    signature = inspect.signature(method)
+    kwargs: dict[str, Any] = {}
+    for parameter in signature.parameters.values():
+        if parameter.name == "self":
+            continue
+        if parameter.kind == inspect.Parameter.VAR_KEYWORD:
+            extra_kwargs: dict[str, Any] = {}
+            if getattr(args, "extra_json", None):
+                raw_extra = _load_json_value(args.extra_json)
+                if not isinstance(raw_extra, dict):
+                    raise ValueError("--set-json must decode to a JSON object.")
+                extra_kwargs.update(raw_extra)
+            for item in getattr(args, "extra_items", []) or []:
+                key, value = _parse_key_value(item)
+                extra_kwargs[key] = value
+            kwargs.update(extra_kwargs)
+            continue
+
+        value = getattr(args, parameter.name)
+        if value is None:
+            if parameter.default is inspect.Signature.empty:
+                raise ValueError(f"--{parameter.name.replace('_', '-')} is required.")
+            continue
+        kwargs[parameter.name] = value
+    return kwargs
+
+
+def main(argv: Optional[Sequence[str]] = None) -> int:
+    parser = build_parser()
+    args = parser.parse_args(argv)
+
+    try:
+        with GitCode(
+            api_key=args.api_key,
+            owner=args.owner,
+            repo=args.repo,
+            base_url=args.base_url,
+            timeout=args.timeout,
+        ) as client:
+            resource = getattr(client, args.resource_name)
+            method = getattr(resource, args.method_name)
+            result = method(**_collect_kwargs(args, method))
+    except (GitCodeError, OSError, TypeError, ValueError) as exc:  # pragma: no cover - integration style
+        print(f"error: {exc}", file=sys.stderr)
+        return 1
+
+    _write_output(result, output_file=args.output_file, compact=args.compact)
+    return 0

gitcode_api-1.1.3/gitcode_api/version.txt

@@ -0,0 +1 @@
+1.1.3

{gitcode_api-1.1.2 → gitcode_api-1.1.3}/gitcode_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gitcode-api
-Version: 1.1.2
+Version: 1.1.3
 Summary: Easy to use Python SDK for the GitCode REST API, community-maintained.
 Author-email: Hugo Huang <hugo@hugohuang.com>
 License-Expression: MIT
@@ -46,7 +46,7 @@ Dynamic: license-file
 Install from PyPI:
 
 ```bash
-pip install gitcode-api
+pip install -U gitcode-api
 ```
 
 ## Authentication
@@ -71,6 +71,19 @@ client = GitCode(
 )
 ```
 
+## CLI
+
+After installation, you can invoke the SDK directly from the command line:
+
+```bash
+gitcode-api repos get --api-key "$GITCODE_ACCESS_TOKEN" --owner SushiNinja --repo GitCode-API
+python -m gitcode_api pulls list --api-key "$GITCODE_ACCESS_TOKEN" --owner SushiNinja --repo GitCode-API --state open
+```
+
+Commands mirror the synchronous resource methods on `GitCode`, using the pattern
+`gitcode-api <resource> <method> ...`. For methods that accept extra `**params`
+or `**payload`, pass repeated `--set key=value` flags or `--set-json '{"key": "value"}'`.
+
 ## Quick Start
 
 ### Sync client

{gitcode_api-1.1.2 → gitcode_api-1.1.3}/gitcode_api.egg-info/SOURCES.txt

@@ -2,14 +2,17 @@ LICENSE
 README.md
 pyproject.toml
 gitcode_api/__init__.py
+gitcode_api/__main__.py
 gitcode_api/_base_client.py
 gitcode_api/_client.py
 gitcode_api/_exceptions.py
 gitcode_api/_models.py
+gitcode_api/cli.py
 gitcode_api/version.txt
 gitcode_api.egg-info/PKG-INFO
 gitcode_api.egg-info/SOURCES.txt
 gitcode_api.egg-info/dependency_links.txt
+gitcode_api.egg-info/entry_points.txt
 gitcode_api.egg-info/requires.txt
 gitcode_api.egg-info/top_level.txt
 gitcode_api/resources/__init__.py
@@ -19,6 +22,7 @@ gitcode_api/resources/collaboration.py
 gitcode_api/resources/misc.py
 gitcode_api/resources/repositories.py
 tests/test_base_client.py
+tests/test_cli.py
 tests/test_client.py
 tests/test_models.py
 tests/test_resources_account.py

gitcode_api-1.1.3/gitcode_api.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+gitcode-api = gitcode_api.cli:main

{gitcode_api-1.1.2 → gitcode_api-1.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "gitcode-api"
-version = "1.1.2"
+version = "1.1.3"
 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"
@@ -51,6 +51,9 @@ documentation = "https://gitcode-api.readthedocs.io"
 gitcode = "https://gitcode.com/SushiNinja/GitCode-API"
 github = "https://github.com/Trenza1ore/GitCode-API"
 
+[project.scripts]
+gitcode-api = "gitcode_api.cli:main"
+
 [tool.uv]
 default-groups = ['test']
 

gitcode_api-1.1.3/tests/test_cli.py

@@ -0,0 +1,127 @@
+from pathlib import Path
+from typing import Any
+
+import httpx
+
+from gitcode_api.cli import build_parser, main
+
+
+def _mock_sync_client(monkeypatch: Any, handler: Any) -> None:
+    mock_transport = httpx.MockTransport(handler)
+    real_client = httpx.Client
+
+    def client_with_mock_transport(*args: object, **kwargs: object) -> httpx.Client:
+        merged = dict(kwargs)
+        merged.setdefault("transport", mock_transport)
+        return real_client(*args, **merged)
+
+    monkeypatch.setattr(httpx, "Client", client_with_mock_transport)
+
+
+def test_cli_build_parser_exposes_generated_commands() -> None:
+    parser = build_parser()
+    args = parser.parse_args(
+        [
+            "oauth",
+            "build-authorize-url",
+            "--api-key",
+            "test-token",
+            "--client-id",
+            "cid",
+            "--redirect-uri",
+            "https://example.com/callback",
+        ]
+    )
+
+    assert args.resource_name == "oauth"
+    assert args.method_name == "build_authorize_url"
+
+
+def test_cli_invokes_resource_methods_and_prints_json(capsys: Any, monkeypatch: Any) -> None:
+    captured: dict[str, Any] = {}
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        captured["url"] = str(request.url)
+        return httpx.Response(200, json={"full_name": "SushiNinja/GitCode-API"})
+
+    _mock_sync_client(monkeypatch, handler)
+
+    exit_code = main(
+        [
+            "repos",
+            "get",
+            "--api-key",
+            "test-token",
+            "--owner",
+            "SushiNinja",
+            "--repo",
+            "GitCode-API",
+        ]
+    )
+
+    stdout = capsys.readouterr().out
+    assert exit_code == 0
+    assert "/repos/SushiNinja/GitCode-API" in captured["url"]
+    assert '"full_name": "SushiNinja/GitCode-API"' in stdout
+
+
+def test_cli_supports_extra_kwargs_via_set_flags(capsys: Any, monkeypatch: Any) -> None:
+    captured: dict[str, Any] = {}
+
+    def handler(request: httpx.Request) -> httpx.Response:
+        captured["params"] = dict(request.url.params)
+        return httpx.Response(200, json={"open": 3, "closed": 1})
+
+    _mock_sync_client(monkeypatch, handler)
+
+    exit_code = main(
+        [
+            "pulls",
+            "list",
+            "--api-key",
+            "test-token",
+            "--owner",
+            "SushiNinja",
+            "--repo",
+            "GitCode-API",
+            "--set",
+            "only_count=true",
+            "--set",
+            "reviewer=octocat",
+        ]
+    )
+
+    stdout = capsys.readouterr().out
+    assert exit_code == 0
+    assert captured["params"]["only_count"] == "true"
+    assert captured["params"]["reviewer"] == "octocat"
+    assert '"open": 3' in stdout
+
+
+def test_cli_writes_raw_bytes_to_output_file(tmp_path: Path, monkeypatch: Any) -> None:
+    output_path = tmp_path / "README.txt"
+
+    def handler(_request: httpx.Request) -> httpx.Response:
+        return httpx.Response(200, content=b"hello from gitcode")
+
+    _mock_sync_client(monkeypatch, handler)
+
+    exit_code = main(
+        [
+            "contents",
+            "get-raw",
+            "--api-key",
+            "test-token",
+            "--owner",
+            "SushiNinja",
+            "--repo",
+            "GitCode-API",
+            "--path",
+            "README.md",
+            "--output-file",
+            str(output_path),
+        ]
+    )
+
+    assert exit_code == 0
+    assert output_path.read_bytes() == b"hello from gitcode"

gitcode_api-1.1.2/gitcode_api/version.txt

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