github-local 0.0.1b3763__py3-none-any.whl

github_local/src/constants_github_local.py

@@ -0,0 +1,6 @@
+GITHUB_TOKEN_ENV = "GITHUB_TOKEN"
+GITHUB_ORGANIZATION = "circles-zone"
+GITHUB_API_URL = "https://api.github.com"
+GITHUB_MAX_KEYS_PER_SEARCH = 5  # GitHub search allows up to 5 OR operators
+GITHUB_SEARCH_MAX_PAGES = 10  # GitHub search returns at most 1000 results (10 pages of 100)
+GITHUB_REQUEST_TIMEOUT_SECONDS = 10

github_local/src/github_local.py

@@ -0,0 +1,91 @@
+import re
+from datetime import datetime, timezone
+from typing import Any, Optional
+
+import requests
+from python_sdk_remote.utilities import our_get_env
+
+from .constants_github_local import (
+    GITHUB_API_URL,
+    GITHUB_MAX_KEYS_PER_SEARCH,
+    GITHUB_ORGANIZATION,
+    GITHUB_REQUEST_TIMEOUT_SECONDS,
+    GITHUB_SEARCH_MAX_PAGES,
+    GITHUB_TOKEN_ENV,
+)
+
+WORK_ITEM_KEY_PATTERN = re.compile(r"\b[A-Z][A-Z0-9]+-\d+\b")
+GITHUB_PAGE_SIZE = 100
+
+
+class GitHubLocalException(Exception):
+    pass
+
+
+def is_branch_of_key(branch_name: str, key: str) -> bool:
+    """feature/BU-1-x and BU-1 belong to BU-1, feature/BU-10-x does not."""
+    is_branch_of_key_result = re.fullmatch(rf"(feature/)?{re.escape(key)}([^0-9].*)?", branch_name,
+                                           re.IGNORECASE) is not None
+    return is_branch_of_key_result
+
+
+class GitHubLocal:
+    """Which Jira Work Items were merged to dev, and the branches of a Jira Work Item."""
+
+    def __init__(self, token: Optional[str] = None, organization: str = GITHUB_ORGANIZATION) -> None:
+        self.organization = organization
+        github_token = token or our_get_env(GITHUB_TOKEN_ENV, raise_if_empty=True)
+        self.session = requests.Session()
+        self.session.headers.update({"Accept": "application/vnd.github+json",
+                                     "Authorization": f"Bearer {github_token}"})
+
+    def get_keys_merged_to_dev(self, keys: list[str]) -> set[str]:
+        """PR title = branch name = feature/BU-1234-..., so a merged PR to dev with the key in its title
+        means the Jira Work Item was merged."""
+        merged_keys: set[str] = set()
+        for start in range(0, len(keys), GITHUB_MAX_KEYS_PER_SEARCH):
+            batch = keys[start:start + GITHUB_MAX_KEYS_PER_SEARCH]
+            query = f"org:{self.organization} is:pr is:merged base:dev in:title " + " OR ".join(batch)
+            for page in range(1, GITHUB_SEARCH_MAX_PAGES + 1):
+                search_result = self._get("/search/issues", params={"q": query, "per_page": GITHUB_PAGE_SIZE,
+                                                                    "page": page})
+                pull_requests = search_result.get("items") or []
+                for pull_request in pull_requests:
+                    merged_keys.update(key for key in WORK_ITEM_KEY_PATTERN.findall(
+                        str(pull_request.get("title", "")).upper()) if key in batch)
+                if len(pull_requests) < GITHUB_PAGE_SIZE:
+                    break
+        return merged_keys
+
+    def get_branches(self, repo_name: str, key: str) -> list[dict[str, Any]]:
+        """Branches named feature/<key>... or <key>... (exactly this key) with the age of their last commit."""
+        branches = []
+        for prefix in (f"feature/{key}", key):
+            refs = self._get(f"/repos/{self.organization}/{repo_name}/git/matching-refs/heads/{prefix}",
+                             is_not_found_empty=True)
+            for ref in refs:
+                branch_name = ref["ref"].removeprefix("refs/heads/")
+                if not is_branch_of_key(branch_name, key):
+                    continue
+                commit = self._get(f"/repos/{self.organization}/{repo_name}/commits/{ref['object']['sha']}")
+                last_commit_time = datetime.fromisoformat(commit["commit"]["committer"]["date"].replace("Z", "+00:00"))
+                branches.append({"repo_name": repo_name, "branch_name": branch_name,
+                                 "age": datetime.now(timezone.utc) - last_commit_time})
+        return branches
+
+    def _get(self, path: str, params: Optional[dict[str, Any]] = None, is_not_found_empty: bool = False) -> Any:
+        try:
+            response = self.session.get(f"{GITHUB_API_URL}{path}", params=params,
+                                        timeout=GITHUB_REQUEST_TIMEOUT_SECONDS)
+        except requests.RequestException as exception:
+            raise GitHubLocalException(f"GitHub is unreachable: {exception}")
+        if response.status_code == 404 and is_not_found_empty:
+            response_json: Any = []
+        elif not response.ok:
+            raise GitHubLocalException(f"GitHub GET {path} failed with {response.status_code}: {response.text[:200]}")
+        else:
+            try:
+                response_json = response.json()
+            except ValueError:
+                raise GitHubLocalException(f"GitHub GET {path} returned an invalid response: {response.text[:200]}")
+        return response_json

github_local-0.0.1b3763.dist-info/METADATA

@@ -0,0 +1,23 @@
+Metadata-Version: 2.4
+Name: github-local
+Version: 0.0.1b3763
+Summary: PyPI github-local Python Package owned by Circlez.ai
+Home-page: https://github.com/circles-zone/github-local-python-package
+Author: Circles
+Author-email: info@circlez.ai
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Description-Content-Type: text/markdown
+Requires-Dist: python-sdk-remote
+Requires-Dist: requests
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: requires-dist
+Dynamic: summary
+
+PyPI github-local Python Package owned by Circlez.ai
+GHA: https://github.com/circles-zone/github-local-python-package/actions

github_local-0.0.1b3763.dist-info/RECORD

@@ -0,0 +1,8 @@
+github_local/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+github_local/src/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+github_local/src/constants_github_local.py,sha256=DpI13rmtPCL8IGYwKgqeFwHzNSpyusma1FtFpDSvNs8,318
+github_local/src/github_local.py,sha256=WJTDEiwmNECdNrNAZk6LUrIuTAUOGKlS6Ywdn53ij84,4482
+github_local-0.0.1b3763.dist-info/METADATA,sha256=PL2yPFjgOKmm-gSt9vT2QLNM9tcC4hSX1UVviiDEzpA,731
+github_local-0.0.1b3763.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+github_local-0.0.1b3763.dist-info/top_level.txt,sha256=kuRvIGRqZ28NWumD7H2iy9ocrSK91GES4C2OZxAS3I0,13
+github_local-0.0.1b3763.dist-info/RECORD,,

github_local-0.0.1b3763.dist-info/WHEEL

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

github_local-0.0.1b3763.dist-info/top_level.txt

@@ -0,0 +1 @@
+github_local