cortexflow-github 0.1.0__py3-none-any.whl

cortexflow_github/__init__.py

@@ -0,0 +1,7 @@
+"""cortexflow-github — example CortexFlow plugin: GitHub repo events."""
+
+from cortexflow_github.plugin import GitHubPlugin
+from cortexflow_github.tool import GitHubEventsTool
+
+__all__ = ["GitHubEventsTool", "GitHubPlugin"]
+__version__ = "0.1.0"

cortexflow_github/plugin.py

@@ -0,0 +1,28 @@
+"""GitHubPlugin — registers GitHubEventsTool with the CortexFlow gateway."""
+
+from __future__ import annotations
+
+import os
+
+from cortexflow_sdk import Plugin, PluginMetadata
+
+from cortexflow_github.tool import GitHubEventsTool
+
+
+class GitHubPlugin(Plugin):
+    """Adds a github_events tool. Reads GITHUB_TOKEN from the environment."""
+
+    metadata = PluginMetadata(
+        name="cortexflow-github",
+        version="0.1.0",
+        plugin_type="tool",
+        description="List recent GitHub repository events (pushes, PRs, issues).",
+        permissions=["network"],
+        homepage="https://github.com/TheAmitChandra/CortexFlow",
+    )
+
+    def __init__(self) -> None:
+        self._token = os.getenv("GITHUB_TOKEN")
+
+    def get_tools(self):
+        return [GitHubEventsTool(token=self._token)]

cortexflow_github/tool.py

@@ -0,0 +1,56 @@
+"""GitHubEventsTool — lists recent public events for a GitHub repository."""
+
+from __future__ import annotations
+
+from cortexflow_sdk import Tool, ToolResult
+
+_API_URL = "https://api.github.com/repos/{owner}/{repo}/events"
+
+
+class GitHubEventsTool(Tool):
+    """Fetches recent events (pushes, PRs, issues, stars) for a repo."""
+
+    name = "github_events"
+    description = "List recent GitHub events (pushes, PRs, issues) for a repository."
+    parameters = {
+        "owner": {"type": "str", "description": "Repository owner/org", "required": True},
+        "repo": {"type": "str", "description": "Repository name", "required": True},
+        "limit": {"type": "int", "description": "Max events to return (default 10)", "required": False},
+    }
+    permissions = ["network"]
+
+    def __init__(self, token: str | None = None) -> None:
+        self._token = token
+
+    async def execute(self, owner: str, repo: str, limit: int = 10, **_) -> ToolResult:
+        try:
+            import httpx
+        except ImportError:
+            return ToolResult(tool=self.name, output=None, error="pip install httpx")
+
+        headers = {"Authorization": f"Bearer {self._token}"} if self._token else {}
+        url = _API_URL.format(owner=owner, repo=repo)
+
+        try:
+            async with httpx.AsyncClient() as client:
+                resp = await client.get(
+                    url, headers=headers, params={"per_page": min(limit, 100)}, timeout=10.0,
+                )
+                resp.raise_for_status()
+                events = resp.json()
+        except Exception as exc:
+            return ToolResult(tool=self.name, output=None, error=str(exc))
+
+        formatted = [
+            {
+                "type": e.get("type", "Unknown"),
+                "actor": (e.get("actor") or {}).get("login", "unknown"),
+                "created_at": e.get("created_at", ""),
+            }
+            for e in events[:limit]
+        ]
+        return ToolResult(
+            tool=self.name,
+            output=formatted,
+            metadata={"repo": f"{owner}/{repo}", "count": len(formatted)},
+        )

cortexflow_github-0.1.0.dist-info/METADATA

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: cortexflow-github
+Version: 0.1.0
+Summary: CortexFlow plugin — list recent GitHub repository events (pushes, PRs, issues).
+Author-email: Amit Chandra <amit.vervebot@gmail.com>
+License: MIT
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cortexflow-sdk>=0.1.0
+Requires-Dist: httpx>=0.27.0
+Provides-Extra: dev
+Requires-Dist: pytest>=8.2.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Dynamic: license-file
+
+# cortexflow-github
+
+Example CortexFlow plugin: a `github_events` tool that lists recent events
+(pushes, PRs, issues) for a GitHub repository via the public REST API.
+
+## Install
+
+```bash
+pip install -e ./cortexflow-sdk        # not yet on PyPI
+pip install -e examples/plugins/cortexflow-github
+```
+
+## Usage
+
+Set `GITHUB_TOKEN` in your environment for authenticated requests (raises the
+rate limit from 60/hr to 5000/hr) — optional, the tool works without it.
+
+```python
+from cortexflow_github import GitHubEventsTool
+
+tool = GitHubEventsTool()
+result = await tool.execute(owner="TheAmitChandra", repo="CortexFlow", limit=5)
+print(result.output)
+```
+
+Once installed alongside the CortexFlow gateway, `cortex plugin add
+cortexflow-github` (or simply having it installed in the same environment)
+makes `PluginRegistry.discover()` find it via the `cortexflow.plugins` entry
+point declared in `pyproject.toml`.

cortexflow_github-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+cortexflow_github/__init__.py,sha256=KwW66nD2xqit5ByDhZwoXX_ZW61xBEq-9AUEEiMucFI,248
+cortexflow_github/plugin.py,sha256=aNPtDylQ_wJ97_PQBWctU9luVh7olUWrwvm82csf_4w,804
+cortexflow_github/tool.py,sha256=ss6Fa2F7B9Iz5bicVPVnlTqVUW6d9KkZR8MmXfhfbLw,2098
+cortexflow_github-0.1.0.dist-info/licenses/LICENSE,sha256=7Dz5G7L1S2nxC1KQDChyyWKVx4NDmJJDf-KNruUtrHk,1069
+cortexflow_github-0.1.0.dist-info/METADATA,sha256=Qs8DOfKrbzOHAKuJ3v9m8OS_Rwo1s1pkWNFAct0kJ1U,1422
+cortexflow_github-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+cortexflow_github-0.1.0.dist-info/entry_points.txt,sha256=yceQiBvaq0TE9OExqdHmo_CZkjtaxZFB27VCYiJLtzg,79
+cortexflow_github-0.1.0.dist-info/top_level.txt,sha256=2UxMN6RVw_3YgLXu0mS76X9qOouHr7nFCBFR6J0V9oQ,18
+cortexflow_github-0.1.0.dist-info/RECORD,,

cortexflow_github-0.1.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
+

cortexflow_github-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[cortexflow.plugins]
+cortexflow-github = cortexflow_github.plugin:GitHubPlugin

cortexflow_github-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Amit Chandra
+
+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.

cortexflow_github-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+cortexflow_github