github-rest-api 0.24.5__tar.gz → 0.33.0__tar.gz

github_rest_api-0.33.0/.gemini/system.md

@@ -0,0 +1,10 @@
+You have my permissions to
+
+- read any file on the machine if it's readable to the current user
+- make changes to files under this project only
+- to create and/or remove temporary files under this project only
+- to run shell command `uv`, `fish -n` and `fish_indent` to lint or test Python and fish scripts
+- to run the shell commands which does NOT change any files
+
+However,
+please do NOT commit changes so that I can review the diff locally.

github_rest_api-0.33.0/.github/workflows/create_pr_dev_to_main.yml

@@ -0,0 +1,20 @@
+name: Create PR From dev To main
+on:
+  push:
+    branches:
+      - dev
+jobs:
+  create_pr_dev_to_main:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sudo env UV_INSTALL_DIR="/usr/local/bin" sh
+      - name: Create PR From dev To main
+        run: | 
+          curl -sSL https://raw.githubusercontent.com/legendu-net/github_actions_scripts/main/create_pull_request.py \
+            | uv run --script - \
+            --head-branch dev \
+            --base-branch main \
+            --token ${{ secrets.GITHUBACTIONS }}
+

github_rest_api-0.33.0/.github/workflows/create_pr_to_dev.yml

@@ -0,0 +1,23 @@
+name: Create PR To dev
+on:
+  push:
+    branches-ignore:
+      - main
+      - dev
+      - gh-pages*
+jobs:
+  create_pr_to_dev:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install uv
+        run: | 
+          curl -LsSf https://astral.sh/uv/install.sh | sudo env UV_INSTALL_DIR="/usr/local/bin" sh
+      - uses: actions/checkout@v6
+      - name: Create PR to dev
+        run: | 
+          curl -sSL https://raw.githubusercontent.com/legendu-net/github_actions_scripts/main/create_pull_request.py \
+            | uv run --script - \
+            --head-branch ${{ github.ref_name }} \
+            --base-branch dev \
+            --token ${{ secrets.GITHUBACTIONS }}
+

github_rest_api-0.33.0/.github/workflows/lint.yml

@@ -0,0 +1,25 @@
+name: Lint Code
+
+on:
+  push:
+    branches: [ dev, main ]
+  pull_request:
+    branches: [ dev ]
+
+jobs:
+  lint_code:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+    - name: Install dependencies
+      run: |
+        curl -LsSf https://astral.sh/uv/install.sh | sudo env UV_INSTALL_DIR="/usr/local/bin" sh
+        uv sync --all-extras
+    - name: Check code format
+      run: uv run ruff format --check ./
+    - name: Lint with ruff
+      run: uv run ruff check github_rest_api/ tests/
+    - name: Lint with Ty
+      run: uv run ty check
+    - name: Analyze Dependencies
+      run: uv run deptry .

github_rest_api-0.33.0/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: Release
+on:
+  release:
+    types: [published]
+jobs:
+  release-github_rest_api:
+    name: Release github_rest_api
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+      contents: write
+    steps:
+      - uses: actions/checkout@v6
+      - name: Install uv
+        run: |
+          curl -LsSf https://astral.sh/uv/install.sh | sudo env UV_INSTALL_DIR="/usr/local/bin" sh
+      - name: Build and Publish Package to PyPI
+        run: |
+          uv build
+          ls -lha dist/
+          uv publish -u __token__ -p ${{ secrets.PYPI_GITHUB_REST_API }}

github_rest_api-0.33.0/.gitignore

@@ -0,0 +1,21 @@
+.DS_Store
+.idea/
+.theia/
+.vscode/
+*.ipr
+*.iws
+.ipynb_checkpoints/
+.coverage
+.mypy/
+.mypy_cache/
+.pytype/
+*.crc
+__pycache__/
+venv/
+.venv/
+target/
+dist/
+*.egg-info/
+doc*/_build/
+*.prof
+core

github_rest_api-0.33.0/.gitpod.yml

@@ -0,0 +1,9 @@
+image: dclong/gitpod
+ports:
+  - port: 8888
+tasks:
+  - command: . /scripts/gitpod.sh
+vscode:
+  extensions:
+    - vscodevim.vim@1.23.2
+    - ms-python.python

github_rest_api-0.33.0/GEMINI.md

@@ -0,0 +1,56 @@
+# GitHub REST API Project
+
+A simple Python wrapper for GitHub REST APIs, optimized for use in GitHub Actions automation.
+
+## Project Overview
+
+- **Purpose:** Provide a streamlined interface for interacting with GitHub's REST API
+  and performing Git operations within automation scripts.
+- **Main Technologies:**
+  - **Python 3.11+**: Core language.
+  - **requests**: For HTTP interactions with the GitHub API.
+  - **dulwich**: A pure-Python implementation of Git for repository operations.
+  - **psutil**: For system and process utilities.
+- **Architecture:**
+  - `github_rest_api/github.py`: Contains the `GitHub` class for handling API requests (GET, POST, DELETE, PUT, PATCH).
+  - `github_rest_api/actions/`: Focused utilities for GitHub Actions, including branch management and pushing changes.
+  - `github_rest_api/actions/cargo/`: Specific support for Rust projects (benchmarking and profiling).
+  - `github_rest_api/utils.py`: General-purpose utilities (versioning, partitioning).
+
+## Building and Running
+
+This project uses `uv` for dependency and environment management.
+
+- **Setup Environment:**
+  ```bash
+  uv sync --all-extras
+  ```
+- **Code Formatting:**
+  ```bash
+  uv run ruff format ./
+  ```
+- **Linting:**
+  ```bash
+  uv run ruff check github_rest_api/ tests/
+  ```
+- **Type Checking:**
+  ```bash
+  uv run ty check
+  ```
+- **Dependency Analysis:**
+  ```bash
+  uv run deptry .
+  ```
+- **Running Tests:**
+  ```bash
+  uv run pytest
+  ```
+
+## Development Conventions
+
+- **Code Style:** Strictly follows `ruff` formatting and linting rules.
+- **Type Safety:** Uses `ty` (in addition to standard type hints) to ensure type correctness.
+- **CI/CD:** Automated linting and formatting checks are performed
+  on `push` to `dev`/`main` branches and on `pull_request` to `dev`.
+- **Git Operations:** Prefers `dulwich` for programmatic Git interactions
+  to avoid dependency on a system Git installation where possible.

github_rest_api-0.33.0/PKG-INFO

@@ -0,0 +1,19 @@
+Metadata-Version: 2.4
+Name: github-rest-api
+Version: 0.33.0
+Summary: Simple wrapper of GitHub REST APIs.
+Author-email: Ben Du <longendu@yahoo.com>
+Classifier: Programming Language :: Python :: 3 :: Only
+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.11
+Requires-Dist: dulwich>=0.25.1
+Requires-Dist: psutil>=5.9.4
+Requires-Dist: requests>=2.28.2
+Description-Content-Type: text/markdown
+
+# GitHub REST APIs  |  [@GitHub](https://github.com/legendu-net/github_rest_api)  |  [@PyPI](https://pypi.org/project/github-rest-api/)
+
+Simple wrapper of GitHub REST APIs with a focus on making GitHub Actions automation easy.

github_rest_api-0.33.0/github_rest_api/__init__.py

@@ -0,0 +1,5 @@
+"""GitHub REST APIs."""
+
+from .github import Organization, Repository, RepositoryType, User
+
+__all__ = ["Organization", "Repository", "RepositoryType", "User"]

github_rest_api-0.33.0/github_rest_api/actions/__init__.py

@@ -0,0 +1 @@
+"""GitHub Actions related utils."""

{github_rest_api-0.24.5 → github_rest_api-0.33.0}/github_rest_api/actions/cargo/benchmark.py

@@ -1,24 +1,24 @@
-"""Benchmark action using cargo criterion.
-"""
+"""Benchmark action using cargo criterion."""
+
 from typing import Callable
 import tempfile
 from pathlib import Path
 import datetime
 import shutil
+import subprocess as sp
+from dulwich import porcelain
 from ..utils import (
     config_git,
-    create_branch,
     switch_branch,
     push_branch,
     gen_temp_branch,
     commit_benchmarks,
 )
-from ...utils import run_cmd
 
 
 def _copy_last_dev_bench(bench_dir: Path) -> None:
     branch = gen_temp_branch()
-    create_branch(branch)
+    porcelain.checkout(repo=".", new_branch=branch)
     switch_branch(branch="gh-pages", fetch=True)
     src = bench_dir / "dev/criterion"
     tmpdir = tempfile.mkdtemp()
@@ -30,14 +30,18 @@ def _copy_last_dev_bench(bench_dir: Path) -> None:
     shutil.copytree(tmpdir, target, dirs_exist_ok=True)
 
 
-def _cargo_criterion(bench_dir: Path) -> None:
+def _cargo_criterion(bench_dir: Path, env: str = "") -> None:
     """Run `cargo criterion` to benchmark the specified branch.
     Notice that a temp branch is created for benchmarking.
 
     :param branch: The branch to benchmark.
     """
     _copy_last_dev_bench(bench_dir=bench_dir)
-    run_cmd("cargo criterion --all-features --message-format=json")
+    sp.run(
+        f"{env} cargo criterion --all-features --message-format=json",
+        shell=True,
+        check=True,
+    )
 
 
 def _copy_bench_results(bench_dir: Path, storage: str) -> None:
@@ -63,7 +67,7 @@ def _git_push_gh_pages(bench_dir: Path, pr_number: str) -> str:
     commit_benchmarks(bench_dir=bench_dir)
     timestamp = datetime.datetime.now().strftime("%Y%m%d_%H%M%S")
     branch = f"gh-pages_{pr_number}_{timestamp}"
-    create_branch(branch=branch)
+    porcelain.checkout(repo=".", new_branch=branch)
     push_branch(branch=branch)
     return branch
 
@@ -166,7 +170,7 @@ def _gen_report_ci_markdown(ci: tuple[str, str, str]) -> str:
 
 
 def _sort_cips(
-    cips: list[tuple[tuple[str, str, str], Path]]
+    cips: list[tuple[tuple[str, str, str], Path]],
 ) -> list[tuple[tuple[str, str, str], Path]]:
     """Sort confidence intervals according to the average performance changes."""
 
@@ -221,6 +225,7 @@ def benchmark(
     bench_dir: str | Path = "bench",
     storage: str = "",
     extract_benchmark_name: Callable[[Path], str] = lambda path: path.stem,
+    env: str = "",
 ) -> str:
     """Benchmark using `cargo criterion` and push benchmark results to gh-pages.
 
@@ -230,6 +235,8 @@ def benchmark(
     :param storage: The directory relative to bench_dir for storing this benchmark results.
     If not specified (empty or None), pr_number is used.
     :param extract_benchmark_name: A function to extract a benchmark name from a path.
+    :param env: Environment variables configuration with the format `var1=val1 var2=val2`
+    for the command `cargo-criterion`).
     """
     if isinstance(bench_dir, str):
         bench_dir = Path(bench_dir)
@@ -240,7 +247,7 @@ def benchmark(
         user_email="bench-bot@github.com",
         user_name="bench-bot",
     )
-    _cargo_criterion(bench_dir=bench_dir)  # _branch_*
+    _cargo_criterion(bench_dir=bench_dir, env=env)  # _branch_*
     _copy_bench_results(bench_dir=bench_dir, storage=storage)  # gh-pages
     gen_index_markdown(
         bench_dir=bench_dir, history=1, extract_benchmark_name=extract_benchmark_name

{github_rest_api-0.24.5 → github_rest_api-0.33.0}/github_rest_api/actions/cargo/profiling.py

@@ -1,5 +1,5 @@
-"""Utils for profiling Rust applications.
-"""
+"""Utils for profiling Rust applications."""
+
 from typing import Iterable
 from pathlib import Path
 import time
@@ -8,7 +8,7 @@ import subprocess as sp
 import psutil
 from .utils import build_project
 from ..utils import config_git, switch_branch, push_branch, commit_profiling
-from ...utils import partition, run_cmd
+from ...utils import partition
 
 
 def launch_application(cmd: list[str]) -> int:
@@ -64,13 +64,13 @@ def nperf(pid: int, prof_name: str, prof_dir: str | Path = ".") -> Path:
     yymmdd = time.strftime("%Y%m%d")
     prof_dir.mkdir(exist_ok=True, parents=True)
     data_file = prof_dir / f"{yymmdd}_{prof_name}"
-    run_cmd(f"nperf record -p {pid} -o '{data_file}'")
+    sp.run(f"nperf record -p {pid} -o '{data_file}'", shell=True, check=True)
     return _gen_flamegraph(data_file)
 
 
 def _gen_flamegraph(data_file: Path) -> Path:
     flamegraph = data_file.with_name(data_file.name + ".svg")
-    run_cmd(f"nperf flamegraph '{data_file}' > '{flamegraph}'")
+    sp.run(f"nperf flamegraph '{data_file}' > '{flamegraph}'", shell=True, check=True)
     return flamegraph
 
 
@@ -95,7 +95,7 @@ def _save_flamegraph(prof_dir: Path, history: int = 5):
 
 def _gen_markdown(svgs: Iterable[Path], prof_dir: Path) -> None:
     def _gen_link(svg: Path):
-        svg = svg.name
+        svg: str = svg.name
         yyyymmdd = svg[:8]
         prof_name = svg[9:-4]
         return f"- [{prof_name} - {yyyymmdd}]({svg})"

{github_rest_api-0.24.5 → github_rest_api-0.33.0}/github_rest_api/actions/cargo/utils.py

@@ -1,10 +1,12 @@
-"""Util functions for building GitHub Actions for Rust projects.
-"""
-from ...utils import run_cmd
+"""Util functions for building GitHub Actions for Rust projects."""
+
+import subprocess as sp
 
 
 def build_project(profile: str = "release") -> None:
     """Build the Rust project.
     :param profile: The profile for building.
     """
-    run_cmd(f"RUSTFLAGS=-Awarnings cargo build --profile {profile}")
+    sp.run(
+        f"RUSTFLAGS=-Awarnings cargo build --profile {profile}", shell=True, check=True
+    )

{github_rest_api-0.24.5 → github_rest_api-0.33.0}/github_rest_api/actions/utils.py

@@ -1,39 +1,21 @@
-"""Util functions for GitHub actions.
-"""
+"""Util functions for GitHub actions."""
+
 from typing import Iterable
 from pathlib import Path
 import random
-from ..utils import run_cmd
-
-
-class FailToPushToGitHubException(Exception):
-    """Exception for failure to push a branch to GitHub."""
-
-    def __init__(self, branch: str, branch_alt: str):
-        msg = f"Failed to push the branch {branch} to GitHub!"
-        if branch_alt:
-            msg += f" Pushed to {branch_alt} instead."
-        super().__init__(msg)
+from dulwich import porcelain
+from dulwich.repo import Repo
 
 
-def config_git(local_repo_dir: str, user_email: str, user_name: str):
+def config_git(local_repo_dir: str | Path, user_email: str, user_name: str):
     """Config Git.
     :param local_repo_dir: The root directory of the project.
     :param user_email: The email of the user (no need to be a valid one).
     :param user_name: The name of the user.
     """
-    cmd = f"""git config --global --add safe.directory {local_repo_dir} \
-            && git config --global user.email "{user_email}" \
-            && git config --global user.name "{user_name}"
-        """
-    run_cmd(cmd)
-
-
-def create_branch(branch: str) -> None:
-    """Create a new local branch.
-    :param branch: The new local branch to create.
-    """
-    run_cmd(f"git checkout -b {branch}")
+    config = Repo(local_repo_dir).get_config()
+    config.set(b"user", b"email", user_email.encode())
+    config.set(b"user", b"name", user_name.encode())
 
 
 def switch_branch(branch: str, fetch: bool) -> None:
@@ -42,8 +24,8 @@ def switch_branch(branch: str, fetch: bool) -> None:
     :param fetch: If true, fetch the branch from remote first.
     """
     if fetch:
-        run_cmd(f"git fetch origin {branch}")
-    run_cmd(f"git checkout {branch}")
+        porcelain.fetch(repo=".")
+    porcelain.checkout(repo=".", target=branch)
 
 
 def gen_temp_branch(
@@ -67,26 +49,27 @@ def push_branch(branch: str, branch_alt: str = ""):
     :param branch_alt: An alternative branch name to push to GitHub.
     """
     try:
-        run_cmd(f"git push origin {branch}")
+        porcelain.push(repo=".", refspecs=branch)
     except Exception as err:
         if branch_alt:
-            cmd = f"""git checkout {branch} \
-                && git checkout -b {branch_alt} \
-                && git push origin {branch_alt}
-                """
-            run_cmd(cmd)
-        raise FailToPushToGitHubException(branch, branch_alt) from err
+            porcelain.checkout(repo=".", target=branch)
+            porcelain.checkout(repo=".", new_branch=branch_alt)
+            porcelain.push(repo=".", refspecs=branch_alt)
+        else:
+            raise err
 
 
 def commit_benchmarks(bench_dir: str | Path):
     """Commit changes in the benchmark directory.
     :param bench_dir: The benchmark directory.
     """
-    run_cmd(f"git add {bench_dir} && git commit -m 'add benchmarks'")
+    porcelain.add(paths=bench_dir)
+    porcelain.commit(message="Add benchmarks.")
 
 
 def commit_profiling(prof_dir: str | Path):
     """Commit changes in the profiling directory.
     :param prof_dir: The profiling directory.
     """
-    run_cmd(f"git add {prof_dir} && git commit -m 'update profiling results'")
+    porcelain.add(paths=prof_dir)
+    porcelain.commit(message="Updating profiling results.")