gitcode-api 1.0.0__py3-none-any.whl

gitcode_api-1.0.0.dist-info/METADATA

@@ -0,0 +1,208 @@
+Metadata-Version: 2.4
+Name: gitcode-api
+Version: 1.0.0
+Project-URL: github, https://github.com/Trenza1ore/GitCode-API
+Project-URL: gitcode, https://gitcode.com/SushiNinja/GitCode-API
+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
+Requires-Dist: python-dotenv
+Dynamic: license-file
+
+# GitCode-API
+
+[中文说明](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 namespaces 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 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:
+
+```bash
+export GITCODE_ACCESS_TOKEN="your-token"
+```
+
+## Quick Start
+
+### Sync client
+
+```python
+from gitcode_api import GitCode
+
+client = GitCode(
+    owner="SushiNinja",
+    repo="GitCode-API",
+)
+
+try:
+    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()
+```
+
+### 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()
+
+
+asyncio.run(main())
+```
+
+## Common Workflows
+
+Create a pull request:
+
+```python
+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()
+```
+
+Get the authenticated user:
+
+```python
+from gitcode_api import GitCode
+
+client = GitCode()
+
+try:
+    user = client.users.me()
+    print(user.login)
+finally:
+    client.close()
+```
+
+Search repositories:
+
+```python
+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()
+```
+
+## 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`
+
+## 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.

gitcode_api-1.0.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+gitcode_api/__init__.py,sha256=NvLp28D9brVbmv2ROSZ8mxKDuIamE9xeutBKGl9pra8,497
+gitcode_api/_base_client.py,sha256=zI1WXrCsnjTl5iypee3C878WElZuEr7V8icYhiWa5IE,12346
+gitcode_api/_client.py,sha256=j4Kh1gKH_pJFJC5ppR0jaQ2Xfr1KSrhCwStYzmbeulg,7630
+gitcode_api/_exceptions.py,sha256=KnhyXuSVDhqG8LiCxBDGnztqJi4SJz4Q0EuGU2b8OuU,1127
+gitcode_api/_models.py,sha256=IU4IBkadmQFoJ0rE1iOc7qHHu9GcpO5lB1NtdP3C7oc,6074
+gitcode_api/resources/__init__.py,sha256=nsCKW0bFDZ5ombJZxLThmO82sOuF7o4OKUMRkAmwbwk,1725
+gitcode_api/resources/_shared.py,sha256=uDxrJC18ILm2t7r7-Wx-8Lf5iRFZvXKVgWLwdOBz1D8,2989
+gitcode_api/resources/account.py,sha256=gNS9G4PUulXbJ4p6MDbMyvaGOMst3Ptwg6_jz9wWXA8,29070
+gitcode_api/resources/collaboration.py,sha256=0RDEiQfiRyoTuwSJvwmoMcyUaMnWhcqeCAkWhqM1ND0,54764
+gitcode_api/resources/misc.py,sha256=9it01m_G4KDW39Un2bedjsRqDLS9sgOFF5Z6tnY0xLc,11950
+gitcode_api/resources/repositories.py,sha256=yJ9wytCnODfdBhJmDvSTD0PPzfQHIWvZeccO8yqSofQ,56887
+gitcode_api-1.0.0.dist-info/licenses/LICENSE,sha256=gOACXuWhMu6PJKVLr9RQbxX3HULnZIGNXCaMFJIXhoA,1067
+gitcode_api-1.0.0.dist-info/METADATA,sha256=aU9ldKN-Egu0IQQ3ZeWnSk6__2x6B7I_fq0KLUz-yfg,4878
+gitcode_api-1.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+gitcode_api-1.0.0.dist-info/top_level.txt,sha256=gIlg0ptyOUHJT64ajOjWIhRPYgIQnMIvnhhnesw9fxU,12
+gitcode_api-1.0.0.dist-info/RECORD,,

gitcode_api-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

gitcode_api-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Hugo Huang
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gitcode_api-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+gitcode_api