Python: Add BaseAgent implementation for GitHub Copilot SDK (#3404)

* Added GithubCopilotAgent

* Fixed errors

* Updated examples

* Updated naming and tests

* Resolved comments and more tests

* Updated tool handling

* Updated tool handling

* Small fixes

* Removed default permission handler

* Resolved comments

* Updated positional args

* Updated docstrings

* Small fixes and more examples

* Added example with MCP

Author: dmytrostruk

python/packages/core/agent_framework/github/__init__.py

@@ -0,0 +1,28 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import importlib
+from typing import Any
+
+_IMPORTS: dict[str, tuple[str, str]] = {
+    "GithubCopilotAgent": ("agent_framework_github_copilot", "agent-framework-github-copilot"),
+    "GithubCopilotOptions": ("agent_framework_github_copilot", "agent-framework-github-copilot"),
+    "GithubCopilotSettings": ("agent_framework_github_copilot", "agent-framework-github-copilot"),
+    "__version__": ("agent_framework_github_copilot", "agent-framework-github-copilot"),
+}
+
+
+def __getattr__(name: str) -> Any:
+    if name in _IMPORTS:
+        import_path, package_name = _IMPORTS[name]
+        try:
+            return getattr(importlib.import_module(import_path), name)
+        except ModuleNotFoundError as exc:
+            raise ModuleNotFoundError(
+                f"The package {package_name} is required to use `{name}`. "
+                f"Please use `pip install {package_name}`, or update your requirements.txt or pyproject.toml file."
+            ) from exc
+    raise AttributeError(f"Module `agent_framework.github` has no attribute {name}.")
+
+
+def __dir__() -> list[str]:
+    return list(_IMPORTS.keys())

python/packages/core/agent_framework/github/__init__.pyi

@@ -0,0 +1,15 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+from agent_framework_github_copilot import (
+    GithubCopilotAgent,
+    GithubCopilotOptions,
+    GithubCopilotSettings,
+    __version__,
+)
+
+__all__ = [
+    "GithubCopilotAgent",
+    "GithubCopilotOptions",
+    "GithubCopilotSettings",
+    "__version__",
+]

python/packages/core/pyproject.toml

@@ -50,6 +50,7 @@ all = [
     "agent-framework-copilotstudio",
     "agent-framework-declarative",
     "agent-framework-devui",
+    "agent-framework-github-copilot",
     "agent-framework-lab",
     "agent-framework-mem0",
     "agent-framework-ollama",

python/packages/github_copilot/LICENSE

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

python/packages/github_copilot/README.md

@@ -0,0 +1,11 @@
+# Get Started with Microsoft Agent Framework GitHub Copilot
+
+Please install this package via pip:
+
+```bash
+pip install agent-framework-github-copilot --pre
+```
+
+## GitHub Copilot Agent
+
+The GitHub Copilot agent enables integration with GitHub Copilot, allowing you to interact with Copilot's agentic capabilities through the Agent Framework.

python/packages/github_copilot/agent_framework_github_copilot/__init__.py

@@ -0,0 +1,18 @@
+# Copyright (c) Microsoft. All rights reserved.
+
+import importlib.metadata
+
+from ._agent import GithubCopilotAgent, GithubCopilotOptions
+from ._settings import GithubCopilotSettings
+
+try:
+    __version__ = importlib.metadata.version(__name__)
+except importlib.metadata.PackageNotFoundError:
+    __version__ = "0.0.0"
+
+__all__ = [
+    "GithubCopilotAgent",
+    "GithubCopilotOptions",
+    "GithubCopilotSettings",
+    "__version__",
+]