gitcode-api 1.2.4__py3-none-any.whl → 1.2.6__py3-none-any.whl

gitcode_api-1.2.4.dist-info/METADATA

@@ -1,237 +0,0 @@
-Metadata-Version: 2.4
-Name: gitcode-api
-Version: 1.2.4
-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: documentation, https://gitcode-api.readthedocs.io
-Project-URL: gitcode, https://gitcode.com/SushiNinja/GitCode-API
-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
-Classifier: Programming Language :: Python :: Implementation :: CPython
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: 3.14
-Requires-Python: <4,>=3.9
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: httpx
-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)](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)](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)
-
-`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.
-
-## Why This Project
-
-- Community project for developers who want a practical GitCode Python library.
-- Sync and async clients with a consistent API surface.
-- 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/`.
-
-## Installation
-
-Install from PyPI:
-
-```bash
-pip install -U gitcode-api
-```
-
-## Authentication
-
-Pass `api_key=` directly, or set `GITCODE_ACCESS_TOKEN` in your environment:
-
-```bash
-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,
-)
-```
-
-## 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
-
-```python
-from gitcode_api import GitCode
-
-client = GitCode(
-    owner="SushiNinja",
-    repo="GitCode-API",
-)
-
-repo = client.repos.get()
-branches = client.branches.list(per_page=5)
-
-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")
-    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`. 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
-
-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())
-```
-
-## Common Workflows
-
-Create a pull request:
-
-```python
-from gitcode_api import GitCode
-
-client = GitCode(owner="SushiNinja", repo="GitCode-API")
-
-pull = client.pulls.create(
-    title="Add feature",
-    head="feature-branch",
-    base="main",
-    body="Implements the new flow.",
-)
-print(pull.number)
-```
-
-Get the authenticated user:
-
-```python
-from gitcode_api import GitCode
-
-client = GitCode()
-
-user = client.users.me()
-print(user.login)
-```
-
-Search repositories:
-
-```python
-from gitcode_api import GitCode
-
-client = GitCode()
-
-repos = client.search.repositories(q="sdk language:python", per_page=10)
-for repo in repos:
-    print(repo.full_name)
-```
-
-## Available Resources
-
-Both `GitCode` and `AsyncGitCode` expose:
-
-- `repos` and `contents`
-- `branches` and `commits`
-- `issues` and `pulls`
-- `labels`, `milestones`, and `members`
-- `releases`, `tags`, and `webhooks`
-- `users`, `orgs`, `search`, and `oauth`
-
-Every resource group inherits a cached `methods` property from the shared resource base: a `tuple` of public callable names in stable SDK order (underscore-segment sort key, not plain A–Z on the full identifier). Private names and the introspection helpers `methods` and `method_signature` are omitted. For example, `client.pulls.methods` helps with discovery or tooling without reading the full manual list. For one method’s parameters and return type, call `client.pulls.method_signature("list_issues")` (a cached string from `inspect.signature`, with `gitcode_api._models.` stripped from annotations).
-
-## Examples
-
-Runnable examples live in `examples/`:
-
-- `get_current_user.py`
-- `get_repository_overview.py`
-- `list_pull_requests.py`
-- `async_list_branches.py`
-
-Example scripts load shared configuration from `examples/.env` using `python-dotenv`.
-
-```bash
-uv run python examples/get_current_user.py
-uv run python examples/get_repository_overview.py
-uv run python examples/list_pull_requests.py
-uv run python examples/async_list_branches.py
-```
-
-See `examples/.env.example` for the expected variables.
-
-## Documentation
-
-- Project docs entry: `docs/index.rst`
-- SDK docs: `docs/sdk/index.rst`
-- REST API mirror: `docs/rest_api/index.rst`
-
-Build the docs locally with Sphinx:
-
-```bash
-uv run --group docs sphinx-build -b html docs docs/_build/html
-```
-
-## Project Status
-
-This is a community project and is still evolving. API coverage is already broad, but some endpoints and behaviors may continue to be refined as the SDK grows.
-
-## Contributing
-
-Issues, bug reports, API coverage improvements, docs fixes, and pull requests are welcome. If you are using GitCode heavily and notice missing endpoints or awkward ergonomics, contributions are especially appreciated.