microsoft-copilot-sdk 1.0.29.dev42910103371__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
copilot/__init__.py ADDED
@@ -0,0 +1,540 @@
1
+ """
2
+ Copilot SDK - Python Client for GitHub Copilot CLI
3
+
4
+ JSON-RPC based SDK for programmatic control of GitHub Copilot CLI
5
+ """
6
+
7
+ from importlib.metadata import PackageNotFoundError
8
+ from importlib.metadata import version as _pkg_version
9
+
10
+ from . import rpc as rpc # noqa: F401 -- register the public ``copilot.rpc`` namespace
11
+
12
+ # Register the public ``copilot.session_events`` namespace.
13
+ from . import session_events as session_events # noqa: F401
14
+ from ._generated.rpc import (
15
+ CurrentModel,
16
+ CurrentToolMetadata,
17
+ EntraAuthConfig,
18
+ EntraTokenAcquireReason,
19
+ EntraTokenAcquireRequestKind,
20
+ EntraTokenAcquireResultKind,
21
+ ExtensionLaunchProfile,
22
+ ExtensionLaunchProviderHandler,
23
+ ExtensionLaunchProviderResolveRequest,
24
+ ExtensionLaunchProviderResolveResult,
25
+ GitHubTelemetryClientInfo,
26
+ GitHubTelemetryEvent,
27
+ GitHubTelemetryNotification,
28
+ GitHubTokenAcquireReason,
29
+ GitHubTokenAcquireResult,
30
+ GitHubTokenAcquireResultKind,
31
+ HostDiagnostics,
32
+ HostErrorReportingStatus,
33
+ ModelBillingTokenPrices,
34
+ ModelBillingTokenPricesLongContext,
35
+ ModelSwitchAutoTierResult,
36
+ ModelSwitchAutoTierStatus,
37
+ NetworkAuthenticateNegotiateRequest,
38
+ NetworkResolveProxyRequest,
39
+ NetworkScope,
40
+ PermissionDecisionContext,
41
+ PermissionDecisionOutcome,
42
+ PermissionDecisionSurface,
43
+ PermissionResponseCapability,
44
+ SkillProviderDescriptor,
45
+ )
46
+ from ._generated.session_events import (
47
+ AutoTierSwitchFailureReason,
48
+ PermissionDecisionSource,
49
+ PermissionMode,
50
+ PermissionRequest,
51
+ SessionAutoTierSwitchFailedData,
52
+ SessionEvent,
53
+ SessionEventType,
54
+ )
55
+ from ._jsonrpc import JsonRpcError
56
+ from ._mode import (
57
+ BUILTIN_TOOLS_ISOLATED,
58
+ CopilotClientMode,
59
+ ToolSet,
60
+ )
61
+ from .canvas import (
62
+ CanvasAction,
63
+ CanvasDeclaration,
64
+ CanvasError,
65
+ CanvasHandler,
66
+ CanvasHostContext,
67
+ CanvasHostContextCapabilities,
68
+ CanvasJsonSchema,
69
+ CanvasProviderIdentity,
70
+ ExtensionInfo,
71
+ OpenCanvasInstance,
72
+ )
73
+ from .client import (
74
+ AskUserVariant,
75
+ AutoTier,
76
+ CapiSessionOptions,
77
+ ChildProcessRuntimeConnection,
78
+ ClientInfo,
79
+ CloudSessionOptions,
80
+ CloudSessionRepository,
81
+ CopilotClient,
82
+ CopilotExpAssignmentResponse,
83
+ DisableBypassPermissionsModes,
84
+ ExpConfigEntry,
85
+ ExpFlagValue,
86
+ GetAuthStatusResponse,
87
+ GetStatusResponse,
88
+ GitHubTokenCancelledResult,
89
+ GitHubTokenProvider,
90
+ GitHubTokenProviderArgs,
91
+ GitHubTokenProviderResult,
92
+ GitHubTokenResult,
93
+ InProcessRuntimeConnection,
94
+ LogLevel,
95
+ ManagedSettings,
96
+ ManagedSettingsPermissions,
97
+ ModelBilling,
98
+ ModelCapabilities,
99
+ ModelInfo,
100
+ ModelLimits,
101
+ ModelPolicy,
102
+ ModelSupports,
103
+ ModelVisionLimits,
104
+ NetworkConfig,
105
+ PingResponse,
106
+ RemoteSessionMode,
107
+ RuntimeConnection,
108
+ SessionBackgroundEvent,
109
+ SessionContext,
110
+ SessionCreatedEvent,
111
+ SessionDeletedEvent,
112
+ SessionForegroundEvent,
113
+ SessionLifecycleEvent,
114
+ SessionLifecycleEventBase,
115
+ SessionLifecycleEventMetadata,
116
+ SessionLifecycleEventType,
117
+ SessionLifecycleHandler,
118
+ SessionListFilter,
119
+ SessionMetadata,
120
+ SessionUpdatedEvent,
121
+ StdioRuntimeConnection,
122
+ StopError,
123
+ TcpRuntimeConnection,
124
+ TelemetryConfig,
125
+ UriRuntimeConnection,
126
+ )
127
+ from .copilot_request_handler import (
128
+ CopilotRequestContext,
129
+ CopilotRequestHandler,
130
+ CopilotWebSocketCloseStatus,
131
+ CopilotWebSocketForwarder,
132
+ CopilotWebSocketHandler,
133
+ LlmInferenceHeaders,
134
+ )
135
+ from .entra import (
136
+ EntraAuthOptions,
137
+ EntraTokenProvider,
138
+ EntraTokenProviderArgs,
139
+ EntraTokenProviderContext,
140
+ EntraTokenProviderResult,
141
+ )
142
+ from .host import (
143
+ AhpAuthenticationRequest,
144
+ AhpAuthenticationResult,
145
+ AhpHost,
146
+ AhpHostAuthentication,
147
+ AhpHostExit,
148
+ AhpHostOptions,
149
+ AhpSessionAuthentication,
150
+ AhpSessionCreateRequest,
151
+ AhpSessionResumeRequest,
152
+ )
153
+ from .installation_confirmation import (
154
+ InstallationConfirmationContext,
155
+ InstallationConfirmationDecision,
156
+ InstallationConfirmationHandler,
157
+ )
158
+ from .session import (
159
+ AgentMessageSource,
160
+ AgentStopHandler,
161
+ AgentStopHookInput,
162
+ AgentStopHookOutput,
163
+ AttributedPermissionResult,
164
+ AutoModeRecoveryContext,
165
+ AutoModeSwitchHandler,
166
+ AutoModeSwitchRequest,
167
+ AutoModeSwitchResponse,
168
+ AutopilotOptions,
169
+ BearerTokenProvider,
170
+ CommandContext,
171
+ CommandDefinition,
172
+ CopilotSession,
173
+ CreateSessionFsHandler,
174
+ ElicitationContext,
175
+ ElicitationHandler,
176
+ ElicitationParams,
177
+ ElicitationResult,
178
+ ErrorOccurredHandler,
179
+ ErrorOccurredHookInput,
180
+ ErrorOccurredHookOutput,
181
+ ExitPlanModeHandler,
182
+ ExitPlanModeRequest,
183
+ ExitPlanModeResult,
184
+ GitHubMcpToolConfig,
185
+ ImageGenerationConfig,
186
+ InfiniteSessionConfig,
187
+ InputOptions,
188
+ LargeToolOutputConfig,
189
+ McpAuthContext,
190
+ McpAuthHandler,
191
+ McpAuthRequest,
192
+ McpAuthResult,
193
+ McpAuthStaticClientConfig,
194
+ McpAuthToken,
195
+ McpAuthWwwAuthenticateParams,
196
+ MCPHTTPServerConfig,
197
+ MCPServerConfig,
198
+ MCPStdioServerConfig,
199
+ MessageSource,
200
+ ModelCapabilitiesOverride,
201
+ ModelLimitsOverride,
202
+ ModelSupportsOverride,
203
+ ModelVisionLimitsOverride,
204
+ NamedProviderConfig,
205
+ PermissionHandler,
206
+ PermissionNoResult,
207
+ PermissionRequestResult,
208
+ PostToolUseFailureHandler,
209
+ PostToolUseFailureHookInput,
210
+ PostToolUseFailureHookOutput,
211
+ PostToolUseHandler,
212
+ PostToolUseHookInput,
213
+ PostToolUseHookOutput,
214
+ PreMcpToolCallHandler,
215
+ PreMcpToolCallHookInput,
216
+ PreMcpToolCallHookOutput,
217
+ PreToolUseHandler,
218
+ PreToolUseHookInput,
219
+ PreToolUseHookOutput,
220
+ ProviderConfig,
221
+ ProviderConfigModelProvider,
222
+ ProviderModelConfig,
223
+ ProviderTokenArgs,
224
+ ReasoningSummary,
225
+ SessionCapabilities,
226
+ SessionEndHandler,
227
+ SessionEndHookInput,
228
+ SessionEndHookOutput,
229
+ SessionEventHandler,
230
+ SessionFsCapabilities,
231
+ SessionFsConfig,
232
+ SessionHooks,
233
+ SessionLimitsConfig,
234
+ SessionStartHandler,
235
+ SessionStartHookInput,
236
+ SessionStartHookOutput,
237
+ SessionUiApi,
238
+ SessionUiCapabilities,
239
+ SkillProvider,
240
+ StoredMemory,
241
+ SubagentStartHandler,
242
+ SubagentStartHookInput,
243
+ SubagentStartHookOutput,
244
+ SubagentStopHandler,
245
+ SubagentStopHookInput,
246
+ SubagentStopHookOutput,
247
+ SystemMessageConfig,
248
+ ToolSearchConfig,
249
+ TranscriptRecoveryReport,
250
+ UserInputHandler,
251
+ UserInputRequest,
252
+ UserInputResponse,
253
+ UserPromptSubmittedHandler,
254
+ UserPromptSubmittedHookInput,
255
+ UserPromptSubmittedHookOutput,
256
+ UserPromptTransformedHandler,
257
+ UserPromptTransformedHookInput,
258
+ UserPromptTransformedHookOutput,
259
+ create_attributed_permission_result,
260
+ )
261
+ from .session_fs_provider import (
262
+ SessionFsBinaryProvider,
263
+ SessionFsByteRange,
264
+ SessionFsFileInfo,
265
+ SessionFsProvider,
266
+ SessionFsReadFileRangeProvider,
267
+ SessionFsSqliteProvider,
268
+ SessionFsSqliteQueryResult,
269
+ SessionFsSqliteTransactionFailure,
270
+ SessionFsWriteFailure,
271
+ create_session_fs_adapter,
272
+ )
273
+ from .tools import (
274
+ Tool,
275
+ ToolBinaryResult,
276
+ ToolInvocation,
277
+ ToolNamespace,
278
+ ToolResult,
279
+ ToolResultType,
280
+ convert_mcp_call_tool_result,
281
+ define_tool,
282
+ )
283
+
284
+ try:
285
+ __version__ = _pkg_version("microsoft-copilot-sdk")
286
+ except PackageNotFoundError:
287
+ # No installed package metadata (e.g. running from a source checkout that
288
+ # was never installed). Use a sentinel that can never masquerade as a real
289
+ # release rather than a hardcoded version that would silently go stale.
290
+ __version__ = "0.0.0.dev0"
291
+
292
+ __all__ = [
293
+ "JsonRpcError",
294
+ "EntraAuthOptions",
295
+ "EntraTokenAcquireReason",
296
+ "EntraTokenAcquireRequestKind",
297
+ "EntraTokenAcquireResultKind",
298
+ "EntraTokenProvider",
299
+ "EntraTokenProviderArgs",
300
+ "EntraTokenProviderContext",
301
+ "EntraTokenProviderResult",
302
+ "AhpAuthenticationRequest",
303
+ "AhpAuthenticationResult",
304
+ "AhpHostAuthentication",
305
+ "AhpSessionAuthentication",
306
+ "AhpHost",
307
+ "AhpHostExit",
308
+ "AhpHostOptions",
309
+ "AhpSessionCreateRequest",
310
+ "AhpSessionResumeRequest",
311
+ "AgentMessageSource",
312
+ "AgentStopHandler",
313
+ "AgentStopHookInput",
314
+ "AgentStopHookOutput",
315
+ "AttributedPermissionResult",
316
+ "AutoModeRecoveryContext",
317
+ "AutoModeSwitchHandler",
318
+ "AutoModeSwitchRequest",
319
+ "AutoModeSwitchResponse",
320
+ "AskUserVariant",
321
+ "AutoTier",
322
+ "SessionAutoTierSwitchFailedData",
323
+ "AutoTierSwitchFailureReason",
324
+ "CurrentModel",
325
+ "ModelSwitchAutoTierResult",
326
+ "ModelSwitchAutoTierStatus",
327
+ "BUILTIN_TOOLS_ISOLATED",
328
+ "CanvasAction",
329
+ "CanvasDeclaration",
330
+ "CanvasError",
331
+ "CanvasHandler",
332
+ "CanvasHostContext",
333
+ "CanvasHostContextCapabilities",
334
+ "CanvasJsonSchema",
335
+ "CanvasProviderIdentity",
336
+ "CapiSessionOptions",
337
+ "ChildProcessRuntimeConnection",
338
+ "ClientInfo",
339
+ "EntraAuthConfig",
340
+ "CloudSessionOptions",
341
+ "CloudSessionRepository",
342
+ "CommandContext",
343
+ "CommandDefinition",
344
+ "CopilotClient",
345
+ "CopilotClientMode",
346
+ "CopilotExpAssignmentResponse",
347
+ "CopilotSession",
348
+ "TranscriptRecoveryReport",
349
+ "CopilotRequestContext",
350
+ "CopilotRequestHandler",
351
+ "CopilotWebSocketCloseStatus",
352
+ "CopilotWebSocketHandler",
353
+ "CreateSessionFsHandler",
354
+ "CurrentToolMetadata",
355
+ "ElicitationContext",
356
+ "ElicitationHandler",
357
+ "ElicitationParams",
358
+ "ElicitationResult",
359
+ "ErrorOccurredHandler",
360
+ "ErrorOccurredHookInput",
361
+ "ErrorOccurredHookOutput",
362
+ "ExpConfigEntry",
363
+ "ExpFlagValue",
364
+ "ExitPlanModeHandler",
365
+ "ExitPlanModeRequest",
366
+ "ExitPlanModeResult",
367
+ "ExtensionLaunchProfile",
368
+ "ExtensionLaunchProviderHandler",
369
+ "ExtensionLaunchProviderResolveRequest",
370
+ "ExtensionLaunchProviderResolveResult",
371
+ "ExtensionInfo",
372
+ "CopilotWebSocketForwarder",
373
+ "DisableBypassPermissionsModes",
374
+ "GetAuthStatusResponse",
375
+ "BearerTokenProvider",
376
+ "GetStatusResponse",
377
+ "HostDiagnostics",
378
+ "HostErrorReportingStatus",
379
+ "GitHubMcpToolConfig",
380
+ "GitHubTelemetryClientInfo",
381
+ "GitHubTelemetryEvent",
382
+ "GitHubTelemetryNotification",
383
+ "GitHubTokenAcquireReason",
384
+ "GitHubTokenAcquireResult",
385
+ "GitHubTokenAcquireResultKind",
386
+ "GitHubTokenProvider",
387
+ "GitHubTokenProviderArgs",
388
+ "GitHubTokenProviderResult",
389
+ "GitHubTokenResult",
390
+ "GitHubTokenCancelledResult",
391
+ "InfiniteSessionConfig",
392
+ "InstallationConfirmationContext",
393
+ "InstallationConfirmationDecision",
394
+ "InstallationConfirmationHandler",
395
+ "InProcessRuntimeConnection",
396
+ "InputOptions",
397
+ "LargeToolOutputConfig",
398
+ "LlmInferenceHeaders",
399
+ "LogLevel",
400
+ "MCPHTTPServerConfig",
401
+ "MCPServerConfig",
402
+ "MCPStdioServerConfig",
403
+ "McpAuthContext",
404
+ "McpAuthHandler",
405
+ "McpAuthRequest",
406
+ "McpAuthResult",
407
+ "McpAuthStaticClientConfig",
408
+ "McpAuthToken",
409
+ "McpAuthWwwAuthenticateParams",
410
+ "ManagedSettings",
411
+ "ManagedSettingsPermissions",
412
+ "MessageSource",
413
+ "ModelBilling",
414
+ "ModelBillingTokenPrices",
415
+ "ModelBillingTokenPricesLongContext",
416
+ "ModelCapabilities",
417
+ "ModelCapabilitiesOverride",
418
+ "ModelInfo",
419
+ "ModelLimits",
420
+ "ModelLimitsOverride",
421
+ "ModelPolicy",
422
+ "ModelSupports",
423
+ "ModelSupportsOverride",
424
+ "ModelVisionLimits",
425
+ "ModelVisionLimitsOverride",
426
+ "NamedProviderConfig",
427
+ "NetworkAuthenticateNegotiateRequest",
428
+ "NetworkConfig",
429
+ "NetworkResolveProxyRequest",
430
+ "NetworkScope",
431
+ "OpenCanvasInstance",
432
+ "PermissionHandler",
433
+ "PermissionMode",
434
+ "PermissionNoResult",
435
+ "PermissionRequest",
436
+ "PermissionRequestResult",
437
+ "PermissionDecisionContext",
438
+ "PermissionDecisionOutcome",
439
+ "PermissionDecisionSource",
440
+ "PermissionDecisionSurface",
441
+ "PermissionResponseCapability",
442
+ "PingResponse",
443
+ "PostToolUseHandler",
444
+ "PostToolUseFailureHandler",
445
+ "PostToolUseFailureHookInput",
446
+ "PostToolUseFailureHookOutput",
447
+ "PostToolUseHookInput",
448
+ "PostToolUseHookOutput",
449
+ "PreMcpToolCallHandler",
450
+ "PreMcpToolCallHookInput",
451
+ "PreMcpToolCallHookOutput",
452
+ "PreToolUseHandler",
453
+ "PreToolUseHookInput",
454
+ "PreToolUseHookOutput",
455
+ "ProviderConfig",
456
+ "ProviderConfigModelProvider",
457
+ "ProviderModelConfig",
458
+ "ProviderTokenArgs",
459
+ "ReasoningSummary",
460
+ "RemoteSessionMode",
461
+ "RuntimeConnection",
462
+ "rpc",
463
+ "session_events",
464
+ "SessionBackgroundEvent",
465
+ "SessionCapabilities",
466
+ "SessionContext",
467
+ "SessionCreatedEvent",
468
+ "SessionDeletedEvent",
469
+ "SessionEndHandler",
470
+ "SessionEndHookInput",
471
+ "SessionEndHookOutput",
472
+ "SessionEvent",
473
+ "SessionEventHandler",
474
+ "SessionEventType",
475
+ "SessionForegroundEvent",
476
+ "SessionFsCapabilities",
477
+ "SessionFsConfig",
478
+ "SessionFsFileInfo",
479
+ "SessionFsProvider",
480
+ "SessionFsBinaryProvider",
481
+ "SessionFsByteRange",
482
+ "SessionFsReadFileRangeProvider",
483
+ "SessionFsSqliteProvider",
484
+ "SessionFsSqliteQueryResult",
485
+ "SessionFsSqliteTransactionFailure",
486
+ "SessionFsWriteFailure",
487
+ "SessionHooks",
488
+ "SessionLimitsConfig",
489
+ "AutopilotOptions",
490
+ "SessionLifecycleEvent",
491
+ "SessionLifecycleEventBase",
492
+ "SessionLifecycleEventMetadata",
493
+ "SessionLifecycleEventType",
494
+ "SessionLifecycleHandler",
495
+ "SessionListFilter",
496
+ "SessionMetadata",
497
+ "SessionStartHandler",
498
+ "SessionStartHookInput",
499
+ "SessionStartHookOutput",
500
+ "SkillProvider",
501
+ "SkillProviderDescriptor",
502
+ "SessionUiApi",
503
+ "SessionUiCapabilities",
504
+ "SessionUpdatedEvent",
505
+ "StdioRuntimeConnection",
506
+ "StoredMemory",
507
+ "StopError",
508
+ "SubagentStartHandler",
509
+ "SubagentStartHookInput",
510
+ "SubagentStartHookOutput",
511
+ "SubagentStopHandler",
512
+ "SubagentStopHookInput",
513
+ "SubagentStopHookOutput",
514
+ "SystemMessageConfig",
515
+ "TcpRuntimeConnection",
516
+ "TelemetryConfig",
517
+ "Tool",
518
+ "ToolBinaryResult",
519
+ "ToolInvocation",
520
+ "ToolNamespace",
521
+ "ToolResult",
522
+ "ToolResultType",
523
+ "ToolSearchConfig",
524
+ "ImageGenerationConfig",
525
+ "ToolSet",
526
+ "UriRuntimeConnection",
527
+ "UserInputHandler",
528
+ "UserInputRequest",
529
+ "UserInputResponse",
530
+ "UserPromptSubmittedHandler",
531
+ "UserPromptSubmittedHookInput",
532
+ "UserPromptSubmittedHookOutput",
533
+ "UserPromptTransformedHandler",
534
+ "UserPromptTransformedHookInput",
535
+ "UserPromptTransformedHookOutput",
536
+ "convert_mcp_call_tool_result",
537
+ "create_attributed_permission_result",
538
+ "create_session_fs_adapter",
539
+ "define_tool",
540
+ ]
copilot/__main__.py ADDED
@@ -0,0 +1,6 @@
1
+ """Entry point for `python -m copilot`."""
2
+
3
+ from ._cli_download import main
4
+
5
+ if __name__ == "__main__":
6
+ main()