github-rest-api 0.49.0__tar.gz → 0.50.0__tar.gz

{github_rest_api-0.49.0 → github_rest_api-0.50.0}/.github/workflows/test.yaml

@@ -11,8 +11,12 @@ jobs:
         os: 
           - macOS-latest
           - ubuntu-latest
-        python-version: 
-          - "3.12"
+        # The oldest supported patch release, spelled out rather than "3.12":
+        # a bare "3.12" resolves to the runner's system interpreter, which is
+        # below `requires-python` on ubuntu-latest, and uv then fails outright
+        # instead of looking for a compatible interpreter to download.
+        python-version:
+          - "3.12.7"
           - "3.13"
           - "3.14"
     steps:

github_rest_api-0.49.0/GEMINI.md → github_rest_api-0.50.0/AGENTS.md

@@ -7,7 +7,7 @@ A simple Python wrapper for GitHub REST APIs, optimized for use in GitHub Action
 - **Purpose:** Provide a streamlined interface for interacting with GitHub's REST API
   and performing Git operations within automation scripts.
 - **Main Technologies:**
-  - **Python 3.12+**: Core language.
+  - **Python 3.12.7+**: Core language.
   - **requests**: For HTTP interactions with the GitHub API.
   - **dulwich**: A pure-Python implementation of Git for repository operations.
   - **tenacity**: For retry logic on API requests.

github_rest_api-0.50.0/CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

{github_rest_api-0.49.0 → github_rest_api-0.50.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: github-rest-api
-Version: 0.49.0
+Version: 0.50.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.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Python: <4,>=3.12
+Requires-Python: <4,>=3.12.7
 Requires-Dist: dulwich>=0.25.1
 Requires-Dist: psutil>=5.9.4
 Requires-Dist: pynacl>=1.5

{github_rest_api-0.49.0 → github_rest_api-0.50.0}/github_rest_api/github.py

@@ -1465,6 +1465,32 @@ class Repository(GitHub):
             json={"body": body},
         ).json()
 
+    def create_issue_comment_image(
+        self, issue_number: int, url: str, alt: str = "", body: str = ""
+    ) -> dict[str, Any]:
+        """Add a comment containing an image to an issue.
+
+        GitHub has no public API for the attachment upload that its web UI
+        performs on drag and drop, so the image must already be hosted
+        somewhere reachable; this method only references it.
+
+        :param issue_number: The number of the issue.
+        :param url: The URL of an already uploaded image.
+        :param alt: Alt text of the image.
+        :param body: Optional text placed above the image.
+        """
+        # A bracket in the alt text would close the markdown label early and
+        # degrade the whole image to literal text, so escape both brackets
+        # (and the escape character itself, which must come first).
+        alt = alt.replace("\\", "\\\\").replace("[", "\\[").replace("]", "\\]")
+        # The URL is wrapped in angle brackets so that spaces and unbalanced
+        # parentheses, which are common in URLs derived from file names, do
+        # not terminate the markdown link early.
+        image = f"![{alt}](<{url}>)"
+        return self.create_issue_comment(
+            issue_number, f"{body}\n\n{image}" if body else image
+        )
+
     def archive(self) -> requests.Response:
         return self._patch(
             url=self._url_repo,

{github_rest_api-0.49.0 → github_rest_api-0.50.0}/github_rest_api/scripts/github/create_github_repo.py

@@ -1,9 +1,7 @@
 """Add a GitHub repository and initialize a local Git repository with workflows."""
 
 import argparse
-import getpass
 import logging
-import os
 import shutil
 import sys
 from collections.abc import Sequence
@@ -13,17 +11,12 @@ from dulwich import porcelain
 from dulwich.refs import HEADREF, LOCAL_BRANCH_PREFIX, Ref
 
 from github_rest_api import Organization, User
+from github_rest_api.scripts.utils import resolve_github_token, validate_repo
 from github_rest_api.utils import as_str_sequence
 
 logger = logging.getLogger(__name__)
 
 
-def _validate_repo(repo: str) -> None:
-    parts = repo.split("/")
-    if len(parts) != 2 or not parts[0] or not parts[1]:
-        raise ValueError(f"Invalid repo format '{repo}'. Expected 'owner/repo'.")
-
-
 def _create_remote_repo(
     repo: str, private: bool, token: str, is_owner_user: bool
 ) -> None:
@@ -169,15 +162,9 @@ def create_github_repo(
     branches: Sequence[str] = ("main",),
 ) -> None:
     branches = as_str_sequence(branches)
-    token = token or os.getenv("GITHUB_TOKEN", "")
-    if not token:
-        token = getpass.getpass("Please enter your GitHub token: ")
-        if not token:
-            raise ValueError(
-                "No GitHub token is provided (via $GITHUB_TOKEN, --token or at prompt)."
-            )
+    token = resolve_github_token(token)
     repo = repo.strip()
-    _validate_repo(repo)
+    validate_repo(repo)
     _create_remote_repo(
         repo=repo, private=private, token=token, is_owner_user=is_owner_user
     )

{github_rest_api-0.49.0 → github_rest_api-0.50.0}/github_rest_api/scripts/github/release_on_github.py

@@ -1,19 +1,20 @@
-import argparse
-import getpass
-import os
 import re
 import sys
 from pathlib import Path
 
 from github_rest_api import Repository
 from github_rest_api.scripts.utils import (
+    RedactingArgumentParser,
     find_project_root,
     get_project_version,
     get_repo,
+    reject_github_token,
+    resolve_github_token,
 )
 
 
 def _get_release_tag(tag: str, root: Path, validate: bool = True) -> str:
+    reject_github_token("--tag", tag)
     tag = tag.strip()
     if not tag:
         tag = get_project_version(root).strip()
@@ -54,7 +55,14 @@ def release_on_github(
     :param token: GitHub token.
         If not specified, the GITHUB_TOKEN environment variable is used.
     :param validate: If True, validate the tag against semantic versioning format before creating the release.
+    :raises ValueError: If a value that looks like a GitHub token is specified
+        for anything other than the token itself.
     """
+    # A release is public, so a token mistyped into any of these would be
+    # published. -t is the tag on this script rather than the token, which
+    # makes that slip easy; --no-validate would otherwise let it through.
+    reject_github_token("--branch", branch)
+    reject_github_token("--notes", notes)
     root = find_project_root()
     if not root:
         raise FileNotFoundError("Could not find project root (no .git found).")
@@ -65,13 +73,7 @@ def release_on_github(
     if not repo_name:
         raise ValueError("Could not find GitHub repository name.")
 
-    token = token or os.getenv("GITHUB_TOKEN", "")
-    if not token:
-        token = getpass.getpass("Please enter your GitHub token: ")
-        if not token:
-            raise ValueError(
-                "No GitHub token is provided (via $GITHUB_TOKEN, --token or at prompt)."
-            )
+    token = resolve_github_token(token)
     repo = Repository(token=token, repo=repo_name)
     data = {
         "tag_name": tag,
@@ -87,7 +89,7 @@ def release_on_github(
 
 
 def parse_args(args=None, namespace=None):
-    parser = argparse.ArgumentParser(
+    parser = RedactingArgumentParser(
         description="Make a release of the project on GitHub."
     )
     parser.add_argument(
@@ -97,7 +99,9 @@ def parse_args(args=None, namespace=None):
         help="The branch (default to main) from which to make the release.",
     )
     parser.add_argument(
-        "-t",
+        # No short option on purpose: -t reads as the token to anyone used to
+        # the other scripts, and the tag becomes the public name of the
+        # release, so that slip would publish the token.
         "--tag",
         default="",
         help="The tag for the release. If not specified, the version from project configuration is used.",