cortexflow-github 0.1.0__tar.gz

cortexflow_github-0.1.0/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/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,29 @@
+# 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/pyproject.toml

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "cortexflow-github"
+version = "0.1.0"
+description = "CortexFlow plugin — list recent GitHub repository events (pushes, PRs, issues)."
+authors = [{ name = "Amit Chandra", email = "amit.vervebot@gmail.com" }]
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "MIT" }
+dependencies = [
+    "cortexflow-sdk>=0.1.0",
+    "httpx>=0.27.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.2.0",
+    "pytest-asyncio>=0.23.0",
+]
+
+[project.entry-points."cortexflow.plugins"]
+cortexflow-github = "cortexflow_github.plugin:GitHubPlugin"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"

cortexflow_github-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

cortexflow_github-0.1.0/src/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-0.1.0/src/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-0.1.0/src/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/src/cortexflow_github.egg-info/PKG-INFO

@@ -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/src/cortexflow_github.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+README.md
+pyproject.toml
+src/cortexflow_github/__init__.py
+src/cortexflow_github/plugin.py
+src/cortexflow_github/tool.py
+src/cortexflow_github.egg-info/PKG-INFO
+src/cortexflow_github.egg-info/SOURCES.txt
+src/cortexflow_github.egg-info/dependency_links.txt
+src/cortexflow_github.egg-info/entry_points.txt
+src/cortexflow_github.egg-info/requires.txt
+src/cortexflow_github.egg-info/top_level.txt
+tests/test_plugin.py
+tests/test_tool.py

cortexflow_github-0.1.0/src/cortexflow_github.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cortexflow_github-0.1.0/src/cortexflow_github.egg-info/entry_points.txt

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

cortexflow_github-0.1.0/src/cortexflow_github.egg-info/requires.txt

@@ -0,0 +1,6 @@
+cortexflow-sdk>=0.1.0
+httpx>=0.27.0
+
+[dev]
+pytest>=8.2.0
+pytest-asyncio>=0.23.0

cortexflow_github-0.1.0/src/cortexflow_github.egg-info/top_level.txt

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

cortexflow_github-0.1.0/tests/test_plugin.py

@@ -0,0 +1,37 @@
+"""Unit tests for cortexflow_github.plugin — GitHubPlugin."""
+
+from __future__ import annotations
+
+from cortexflow_github.plugin import GitHubPlugin
+from cortexflow_github.tool import GitHubEventsTool
+
+
+def test_plugin_metadata():
+    p = GitHubPlugin()
+    assert p.metadata.name == "cortexflow-github"
+    assert p.metadata.plugin_type == "tool"
+    assert "network" in p.metadata.permissions
+
+
+def test_plugin_reads_token_from_env(monkeypatch):
+    monkeypatch.setenv("GITHUB_TOKEN", "ghp_fromenv")
+    p = GitHubPlugin()
+    assert p._token == "ghp_fromenv"
+
+
+def test_plugin_no_token_in_env(monkeypatch):
+    monkeypatch.delenv("GITHUB_TOKEN", raising=False)
+    p = GitHubPlugin()
+    assert p._token is None
+
+
+def test_get_tools_returns_github_events_tool():
+    tools = GitHubPlugin().get_tools()
+    assert len(tools) == 1
+    assert isinstance(tools[0], GitHubEventsTool)
+
+
+def test_get_tools_tool_carries_plugin_token(monkeypatch):
+    monkeypatch.setenv("GITHUB_TOKEN", "ghp_carried")
+    tool = GitHubPlugin().get_tools()[0]
+    assert tool._token == "ghp_carried"

cortexflow_github-0.1.0/tests/test_tool.py

@@ -0,0 +1,112 @@
+"""Unit tests for cortexflow_github.tool — GitHubEventsTool."""
+
+from __future__ import annotations
+
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import pytest
+from cortexflow_github.tool import GitHubEventsTool
+
+_SAMPLE_EVENTS = [
+    {"type": "PushEvent", "actor": {"login": "alice"}, "created_at": "2026-06-26T10:00:00Z"},
+    {"type": "IssuesEvent", "actor": {"login": "bob"}, "created_at": "2026-06-26T09:00:00Z"},
+]
+
+
+def _make_mock_client(json_body, raise_on_status: Exception | None = None):
+    mock_resp = MagicMock()
+    mock_resp.raise_for_status = MagicMock(side_effect=raise_on_status)
+    mock_resp.json = MagicMock(return_value=json_body)
+
+    mock_client = MagicMock()
+    mock_client.__aenter__ = AsyncMock(return_value=mock_client)
+    mock_client.__aexit__ = AsyncMock(return_value=False)
+    mock_client.get = AsyncMock(return_value=mock_resp)
+    return mock_client
+
+
+@pytest.mark.asyncio
+async def test_execute_returns_formatted_events():
+    tool = GitHubEventsTool()
+    mock_client = _make_mock_client(_SAMPLE_EVENTS)
+
+    with patch("httpx.AsyncClient", return_value=mock_client):
+        result = await tool.execute(owner="TheAmitChandra", repo="CortexFlow", limit=10)
+
+    assert result.success
+    assert len(result.output) == 2
+    assert result.output[0]["actor"] == "alice"
+    assert result.metadata["repo"] == "TheAmitChandra/CortexFlow"
+
+
+@pytest.mark.asyncio
+async def test_execute_respects_limit():
+    tool = GitHubEventsTool()
+    mock_client = _make_mock_client(_SAMPLE_EVENTS)
+
+    with patch("httpx.AsyncClient", return_value=mock_client):
+        result = await tool.execute(owner="o", repo="r", limit=1)
+
+    assert len(result.output) == 1
+
+
+@pytest.mark.asyncio
+async def test_execute_sends_auth_header_when_token_set():
+    tool = GitHubEventsTool(token="ghp_secret")
+    mock_client = _make_mock_client(_SAMPLE_EVENTS)
+
+    with patch("httpx.AsyncClient", return_value=mock_client):
+        await tool.execute(owner="o", repo="r")
+
+    call_kwargs = mock_client.get.call_args[1]
+    assert call_kwargs["headers"]["Authorization"] == "Bearer ghp_secret"
+
+
+@pytest.mark.asyncio
+async def test_execute_no_token_omits_auth_header():
+    tool = GitHubEventsTool()
+    mock_client = _make_mock_client(_SAMPLE_EVENTS)
+
+    with patch("httpx.AsyncClient", return_value=mock_client):
+        await tool.execute(owner="o", repo="r")
+
+    call_kwargs = mock_client.get.call_args[1]
+    assert call_kwargs["headers"] == {}
+
+
+@pytest.mark.asyncio
+async def test_execute_http_error_returns_error_result():
+    tool = GitHubEventsTool()
+    mock_client = _make_mock_client([], raise_on_status=RuntimeError("404 Not Found"))
+
+    with patch("httpx.AsyncClient", return_value=mock_client):
+        result = await tool.execute(owner="o", repo="missing")
+
+    assert not result.success
+    assert "404" in result.error
+
+
+@pytest.mark.asyncio
+async def test_execute_missing_httpx_returns_error():
+    import builtins
+
+    real_import = builtins.__import__
+
+    def fake_import(name, *args, **kwargs):
+        if name == "httpx":
+            raise ImportError("No module named 'httpx'")
+        return real_import(name, *args, **kwargs)
+
+    tool = GitHubEventsTool()
+    with patch("builtins.__import__", side_effect=fake_import):
+        result = await tool.execute(owner="o", repo="r")
+
+    assert not result.success
+    assert "pip install httpx" in result.error
+
+
+def test_tool_schema_marks_owner_and_repo_required():
+    schema = GitHubEventsTool().get_schema()
+    assert "owner" in schema["parameters"]["required"]
+    assert "repo" in schema["parameters"]["required"]
+    assert "limit" not in schema["parameters"]["required"]